A continuation of netlify_openapi_swagger.json. The complete source identity, every recorded occurrence, and linked equations are on its first page.
Source transcript · continued
Download complete source text ↓24,715 lines · 705.9 KB
{
"type": "integer",
"format": "int32",
"name": "per_page",
"required": false,
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "integer",
"format": "int32"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"company": {
"type": "string"
},
"summary": {
"type": "string"
},
"body": {
"type": "string"
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"site_url": {
"type": "string"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"delete": {
"operationId": "deleteSubmission",
"tags": [
"submission"
],
"responses": {
"204": {
"description": "Deleted"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/service-instances": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "listServiceInstancesForSite",
"tags": [
"serviceInstance"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"config": {
"type": "object"
},
"external_attributes": {
"type": "object"
},
"service_slug": {
"type": "string"
},
"service_path": {
"type": "string"
},
"service_name": {
"type": "string"
},
"env": {
"type": "object"
},
"snippets": {
"type": "array",
"items": {
"type": "object"
}
},
"auth_url": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/services/{addon}/instances": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "addon",
"type": "string",
"in": "path",
"required": true
}
],
"post": {
"operationId": "createServiceInstance",
"tags": [
"serviceInstance"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "config",
"in": "body",
"required": true,
"schema": {
"type": "object"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"config": {
"type": "object"
},
"external_attributes": {
"type": "object"
},
"service_slug": {
"type": "string"
},
"service_path": {
"type": "string"
},
"service_name": {
"type": "string"
},
"env": {
"type": "object"
},
"snippets": {
"type": "array",
"items": {
"type": "object"
}
},
"auth_url": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/services/{addon}/instances/{instance_id}": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "addon",
"type": "string",
"in": "path",
"required": true
},
{
"name": "instance_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "showServiceInstance",
"tags": [
"serviceInstance"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"config": {
"type": "object"
},
"external_attributes": {
"type": "object"
},
"service_slug": {
"type": "string"
},
"service_path": {
"type": "string"
},
"service_name": {
"type": "string"
},
"env": {
"type": "object"
},
"snippets": {
"type": "array",
"items": {
"type": "object"
}
},
"auth_url": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"put": {
"operationId": "updateServiceInstance",
"tags": [
"serviceInstance"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "config",
"in": "body",
"required": true,
"schema": {
"type": "object"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"delete": {
"operationId": "deleteServiceInstance",
"tags": [
"serviceInstance"
],
"responses": {
"204": {
"description": "Deleted"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/services/": {
"parameters": [
{
"name": "search",
"type": "string",
"in": "query"
}
],
"get": {
"operationId": "getServices",
"tags": [
"service"
],
"responses": {
"200": {
"description": "services",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"service_path": {
"type": "string"
},
"long_description": {
"type": "string"
},
"description": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"type": "object"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"icon": {
"type": "string"
},
"manifest_url": {
"type": "string"
},
"environments": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/services/{addonName}": {
"parameters": [
{
"name": "addonName",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "showService",
"tags": [
"service"
],
"responses": {
"200": {
"description": "services",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"service_path": {
"type": "string"
},
"long_description": {
"type": "string"
},
"description": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"type": "object"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"icon": {
"type": "string"
},
"manifest_url": {
"type": "string"
},
"environments": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/services/{addonName}/manifest": {
"parameters": [
{
"name": "addonName",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "showServiceManifest",
"tags": [
"service"
],
"responses": {
"201": {
"description": "retrieving from provider",
"schema": {
"type": "object"
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/user": {
"get": {
"operationId": "getCurrentUser",
"tags": [
"user"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"uid": {
"type": "string"
},
"full_name": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"email": {
"type": "string"
},
"affiliate_id": {
"type": "string"
},
"site_count": {
"type": "integer",
"format": "int64"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"last_login": {
"type": "string",
"format": "dateTime"
},
"login_providers": {
"type": "array",
"items": {
"type": "string"
}
},
"onboarding_progress": {
"type": "object",
"properties": {
"slides": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/traffic_splits": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"post": {
"operationId": "createSplitTest",
"tags": [
"splitTest"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "branch_tests",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"branch_tests": {
"type": "object"
}
}
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "object"
}
},
"active": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"unpublished_at": {
"type": "string",
"format": "dateTime"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"get": {
"operationId": "getSplitTests",
"tags": [
"splitTest"
],
"responses": {
"200": {
"description": "split_tests",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "object"
}
},
"active": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"unpublished_at": {
"type": "string",
"format": "dateTime"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/traffic_splits/{split_test_id}": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "split_test_id",
"type": "string",
"in": "path",
"required": true
}
],
"put": {
"operationId": "updateSplitTest",
"tags": [
"splitTest"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "branch_tests",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"branch_tests": {
"type": "object"
}
}
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "object"
}
},
"active": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"unpublished_at": {
"type": "string",
"format": "dateTime"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"get": {
"operationId": "getSplitTest",
"tags": [
"splitTest"
],
"responses": {
"200": {
"description": "split_test",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "object"
}
},
"active": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"unpublished_at": {
"type": "string",
"format": "dateTime"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/traffic_splits/{split_test_id}/publish": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "split_test_id",
"type": "string",
"in": "path",
"required": true
}
],
"post": {
"operationId": "enableSplitTest",
"tags": [
"splitTest"
],
"responses": {
"204": {
"description": "enable"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/traffic_splits/{split_test_id}/unpublish": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "split_test_id",
"type": "string",
"in": "path",
"required": true
}
],
"post": {
"operationId": "disableSplitTest",
"tags": [
"splitTest"
],
"responses": {
"204": {
"description": "disabled"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/dns_zones": {
"post": {
"operationId": "createDnsZone",
"tags": [
"dnsZone"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "DnsZoneParams",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"account_slug": {
"type": "string"
},
"site_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_record_types": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"hostname": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "integer",
"format": "int64"
},
"priority": {
"type": "integer",
"format": "int64"
},
"dns_zone_id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"flag": {
"type": "integer"
},
"tag": {
"type": "string"
},
"managed": {
"type": "boolean"
}
}
}
},
"dns_servers": {
"type": "array",
"items": {
"type": "string"
}
},
"account_id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"account_slug": {
"type": "string"
},
"account_name": {
"type": "string"
},
"domain": {
"type": "string"
},
"ipv6_enabled": {
"type": "boolean"
},
"dedicated": {
"type": "boolean"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"get": {
"operationId": "getDnsZones",
"tags": [
"dnsZone"
],
"parameters": [
{
"name": "account_slug",
"in": "query",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "get all DNS zones the user has access to",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_record_types": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"hostname": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "integer",
"format": "int64"
},
"priority": {
"type": "integer",
"format": "int64"
},
"dns_zone_id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"flag": {
"type": "integer"
},
"tag": {
"type": "string"
},
"managed": {
"type": "boolean"
}
}
}
},
"dns_servers": {
"type": "array",
"items": {
"type": "string"
}
},
"account_id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"account_slug": {
"type": "string"
},
"account_name": {
"type": "string"
},
"domain": {
"type": "string"
},
"ipv6_enabled": {
"type": "boolean"
},
"dedicated": {
"type": "boolean"
}
}