diff --git a/package-lock.json b/package-lock.json
index aac55989bd..a810e31363 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -6647,9 +6647,9 @@
}
},
"node_modules/@netlify/open-api": {
- "version": "2.32.0",
- "resolved": "https://registry.npmjs.org/@netlify/open-api/-/open-api-2.32.0.tgz",
- "integrity": "sha512-pw3tfLvKm/6RwF2fNAXe1tJyf6R9OgU/wuGz//N3jhig0FGVNusbt+bwcj5eTzwOvCb0KkUh0OLT8e1gSSz8qQ==",
+ "version": "2.33.0",
+ "resolved": "https://registry.npmjs.org/@netlify/open-api/-/open-api-2.33.0.tgz",
+ "integrity": "sha512-GGIoUb/ARY4pxVgxp8RWDBV4nm1iMzJTuhYpQoOwWoJPKYlCykOMm0PpL0MLuPHzwrF/Q6N3C+fit5nQIVJ83g==",
"license": "MIT",
"engines": {
"node": ">=14"
@@ -27034,7 +27034,7 @@
"dependencies": {
"@import-maps/resolve": "^1.0.1",
"@vercel/nft": "^0.27.0",
- "ajv": "^8.16.0",
+ "ajv": "^8.11.2",
"ajv-errors": "^3.0.0",
"better-ajv-errors": "^1.2.0",
"common-path-prefix": "^3.0.0",
@@ -27369,7 +27369,7 @@
"version": "9.8.13",
"license": "MIT",
"dependencies": {
- "ajv": "^8.16.0",
+ "ajv": "^8.12.0",
"filter-obj": "^5.0.0",
"find-up": "^6.3.0",
"is-plain-obj": "^4.0.0",
@@ -27537,7 +27537,7 @@
"version": "13.1.18",
"license": "MIT",
"dependencies": {
- "@netlify/open-api": "^2.32.0",
+ "@netlify/open-api": "^2.33.0",
"lodash-es": "^4.17.21",
"micro-api-client": "^3.3.0",
"node-fetch": "^3.0.0",
diff --git a/packages/js-client/package.json b/packages/js-client/package.json
index 270297c341..c1dcabdefd 100644
--- a/packages/js-client/package.json
+++ b/packages/js-client/package.json
@@ -41,7 +41,7 @@
"node client"
],
"dependencies": {
- "@netlify/open-api": "^2.32.0",
+ "@netlify/open-api": "^2.33.0",
"lodash-es": "^4.17.21",
"micro-api-client": "^3.3.0",
"node-fetch": "^3.0.0",
diff --git a/packages/js-client/src/operations.test.ts b/packages/js-client/src/operations.test.ts
index aec91c73d7..f9fb8e5b18 100644
--- a/packages/js-client/src/operations.test.ts
+++ b/packages/js-client/src/operations.test.ts
@@ -1,7 +1,18 @@
import test from 'ava'
-import { getOperations } from './operations.js'
+import { openApiSpec } from './open_api.js'
+
+import { NetlifyAPI } from './index.js'
test('Exported methods', (t) => {
- t.snapshot(getOperations())
+ const api = new NetlifyAPI()
+
+ for (const path in openApiSpec.paths) {
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
+ const { parameters: _, ...verbs } = openApiSpec.paths[path]
+
+ for (const verb in verbs) {
+ t.is(typeof api[verbs[verb].operationId], 'function')
+ }
+ }
})
diff --git a/packages/js-client/src/operations.test.ts.md b/packages/js-client/src/operations.test.ts.md
deleted file mode 100644
index 6d0b194893..0000000000
--- a/packages/js-client/src/operations.test.ts.md
+++ /dev/null
@@ -1,15753 +0,0 @@
-# Snapshot report for `src/operations.test.ts`
-
-The actual snapshot is saved in `operations.test.ts.snap`.
-
-Generated by [AVA](https://avajs.dev).
-
-## Exported methods
-
-> Snapshot 1
-
- [
- {
- description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables.',
- operationId: 'listSites',
- parameters: {
- body: {},
- path: {},
- query: {
- filter: {
- enum: [
- 'all',
- 'owner',
- 'guest',
- ],
- in: 'query',
- name: 'filter',
- type: 'string',
- },
- name: {
- in: 'query',
- name: 'name',
- type: 'string',
- },
- page: {
- format: 'int32',
- in: 'query',
- name: 'page',
- required: false,
- type: 'integer',
- },
- per_page: {
- format: 'int32',
- in: 'query',
- name: 'per_page',
- required: false,
- type: 'integer',
- },
- },
- },
- path: '/sites',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- admin_url: {
- type: 'string',
- },
- branch_deploy_custom_domain: {
- type: 'string',
- },
- build_image: {
- type: 'string',
- },
- build_settings: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- capabilities: {
- additionalProperties: {
- type: 'object',
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- custom_domain: {
- type: 'string',
- },
- default_hooks_data: {
- properties: {
- access_token: {
- type: 'string',
- },
- },
- type: 'object',
- },
- deploy_hook: {
- type: 'string',
- },
- deploy_preview_custom_domain: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- domain_aliases: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- force_ssl: {
- type: 'boolean',
- },
- functions_region: {
- type: 'string',
- },
- git_provider: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- id_domain: {
- type: 'string',
- },
- managed_dns: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- notification_email: {
- type: 'string',
- },
- password: {
- type: 'string',
- },
- plan: {
- type: 'string',
- },
- prerender: {
- type: 'string',
- },
- processing_settings: {
- properties: {
- html: {
- properties: {
- pretty_urls: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- published_deploy: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- screenshot_url: {
- type: 'string',
- },
- session_id: {
- type: 'string',
- },
- ssl: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'site',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment variables for a site.',
- operationId: 'createSite',
- parameters: {
- body: {
- site: {
- in: 'body',
- name: 'site',
- required: true,
- schema: {
- allOf: [
- {
- properties: {
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- admin_url: {
- type: 'string',
- },
- branch_deploy_custom_domain: {
- type: 'string',
- },
- build_image: {
- type: 'string',
- },
- build_settings: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- capabilities: {
- additionalProperties: {
- type: 'object',
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- custom_domain: {
- type: 'string',
- },
- default_hooks_data: {
- properties: {
- access_token: {
- type: 'string',
- },
- },
- type: 'object',
- },
- deploy_hook: {
- type: 'string',
- },
- deploy_preview_custom_domain: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- domain_aliases: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- force_ssl: {
- type: 'boolean',
- },
- functions_region: {
- type: 'string',
- },
- git_provider: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- id_domain: {
- type: 'string',
- },
- managed_dns: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- notification_email: {
- type: 'string',
- },
- password: {
- type: 'string',
- },
- plan: {
- type: 'string',
- },
- prerender: {
- type: 'string',
- },
- processing_settings: {
- properties: {
- html: {
- properties: {
- pretty_urls: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- published_deploy: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- screenshot_url: {
- type: 'string',
- },
- session_id: {
- type: 'string',
- },
- ssl: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- {
- properties: {
- repo: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- },
- ],
- },
- },
- },
- path: {},
- query: {
- configure_dns: {
- in: 'query',
- name: 'configure_dns',
- type: 'boolean',
- },
- },
- },
- path: '/sites',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- admin_url: {
- type: 'string',
- },
- branch_deploy_custom_domain: {
- type: 'string',
- },
- build_image: {
- type: 'string',
- },
- build_settings: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- capabilities: {
- additionalProperties: {
- type: 'object',
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- custom_domain: {
- type: 'string',
- },
- default_hooks_data: {
- properties: {
- access_token: {
- type: 'string',
- },
- },
- type: 'object',
- },
- deploy_hook: {
- type: 'string',
- },
- deploy_preview_custom_domain: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- domain_aliases: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- force_ssl: {
- type: 'boolean',
- },
- functions_region: {
- type: 'string',
- },
- git_provider: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- id_domain: {
- type: 'string',
- },
- managed_dns: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- notification_email: {
- type: 'string',
- },
- password: {
- type: 'string',
- },
- plan: {
- type: 'string',
- },
- prerender: {
- type: 'string',
- },
- processing_settings: {
- properties: {
- html: {
- properties: {
- pretty_urls: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- published_deploy: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- screenshot_url: {
- type: 'string',
- },
- session_id: {
- type: 'string',
- },
- ssl: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'site',
- ],
- verb: 'post',
- },
- {
- description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables.',
- operationId: 'getSite',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- feature_flags: {
- in: 'query',
- name: 'feature_flags',
- type: 'string',
- 'x-internal': true,
- },
- },
- },
- path: '/sites/{site_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- admin_url: {
- type: 'string',
- },
- branch_deploy_custom_domain: {
- type: 'string',
- },
- build_image: {
- type: 'string',
- },
- build_settings: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- capabilities: {
- additionalProperties: {
- type: 'object',
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- custom_domain: {
- type: 'string',
- },
- default_hooks_data: {
- properties: {
- access_token: {
- type: 'string',
- },
- },
- type: 'object',
- },
- deploy_hook: {
- type: 'string',
- },
- deploy_preview_custom_domain: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- domain_aliases: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- force_ssl: {
- type: 'boolean',
- },
- functions_region: {
- type: 'string',
- },
- git_provider: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- id_domain: {
- type: 'string',
- },
- managed_dns: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- notification_email: {
- type: 'string',
- },
- password: {
- type: 'string',
- },
- plan: {
- type: 'string',
- },
- prerender: {
- type: 'string',
- },
- processing_settings: {
- properties: {
- html: {
- properties: {
- pretty_urls: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- published_deploy: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- screenshot_url: {
- type: 'string',
- },
- session_id: {
- type: 'string',
- },
- ssl: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'site',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [updateEnvVar](#tag/environmentVariables/operation/updateEnvVar) to update a site\'s environment variables.',
- operationId: 'updateSite',
- parameters: {
- body: {
- site: {
- in: 'body',
- name: 'site',
- required: true,
- schema: {
- allOf: [
- {
- properties: {
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- admin_url: {
- type: 'string',
- },
- branch_deploy_custom_domain: {
- type: 'string',
- },
- build_image: {
- type: 'string',
- },
- build_settings: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- capabilities: {
- additionalProperties: {
- type: 'object',
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- custom_domain: {
- type: 'string',
- },
- default_hooks_data: {
- properties: {
- access_token: {
- type: 'string',
- },
- },
- type: 'object',
- },
- deploy_hook: {
- type: 'string',
- },
- deploy_preview_custom_domain: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- domain_aliases: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- force_ssl: {
- type: 'boolean',
- },
- functions_region: {
- type: 'string',
- },
- git_provider: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- id_domain: {
- type: 'string',
- },
- managed_dns: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- notification_email: {
- type: 'string',
- },
- password: {
- type: 'string',
- },
- plan: {
- type: 'string',
- },
- prerender: {
- type: 'string',
- },
- processing_settings: {
- properties: {
- html: {
- properties: {
- pretty_urls: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- published_deploy: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- screenshot_url: {
- type: 'string',
- },
- session_id: {
- type: 'string',
- },
- ssl: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- {
- properties: {
- repo: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- },
- ],
- },
- },
- },
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- admin_url: {
- type: 'string',
- },
- branch_deploy_custom_domain: {
- type: 'string',
- },
- build_image: {
- type: 'string',
- },
- build_settings: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- capabilities: {
- additionalProperties: {
- type: 'object',
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- custom_domain: {
- type: 'string',
- },
- default_hooks_data: {
- properties: {
- access_token: {
- type: 'string',
- },
- },
- type: 'object',
- },
- deploy_hook: {
- type: 'string',
- },
- deploy_preview_custom_domain: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- domain_aliases: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- force_ssl: {
- type: 'boolean',
- },
- functions_region: {
- type: 'string',
- },
- git_provider: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- id_domain: {
- type: 'string',
- },
- managed_dns: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- notification_email: {
- type: 'string',
- },
- password: {
- type: 'string',
- },
- plan: {
- type: 'string',
- },
- prerender: {
- type: 'string',
- },
- processing_settings: {
- properties: {
- html: {
- properties: {
- pretty_urls: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- published_deploy: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- screenshot_url: {
- type: 'string',
- },
- session_id: {
- type: 'string',
- },
- ssl: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'site',
- ],
- verb: 'patch',
- },
- {
- operationId: 'deleteSite',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}',
- responses: {
- 204: {
- description: 'Deleted',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'site',
- ],
- verb: 'delete',
- },
- {
- operationId: 'provisionSiteTLSCertificate',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- ca_certificates: {
- in: 'query',
- name: 'ca_certificates',
- type: 'string',
- },
- certificate: {
- in: 'query',
- name: 'certificate',
- type: 'string',
- },
- key: {
- in: 'query',
- name: 'key',
- type: 'string',
- },
- },
- },
- path: '/sites/{site_id}/ssl',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- domains: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- expires_at: {
- format: 'dateTime',
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'sniCertificate',
- ],
- verb: 'post',
- },
- {
- operationId: 'showSiteTLSCertificate',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/ssl',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- domains: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- expires_at: {
- format: 'dateTime',
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'sniCertificate',
- ],
- verb: 'get',
- },
- {
- description: 'Returns all environment variables for an account or site. An account corresponds to a team in the Netlify UI. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI.',
- operationId: 'getEnvVars',
- parameters: {
- body: {},
- path: {
- account_id: {
- description: 'Scope response to account_id',
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- context_name: {
- description: 'Filter by deploy context',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- ],
- in: 'query',
- name: 'context_name',
- required: false,
- type: 'string',
- },
- scope: {
- description: 'Filter by scope',
- enum: [
- 'builds',
- 'functions',
- 'runtime',
- 'post-processing',
- ],
- in: 'query',
- name: 'scope',
- required: false,
- type: 'string',
- },
- site_id: {
- description: 'If specified, only return environment variables set on this site',
- in: 'query',
- name: 'site_id',
- required: false,
- type: 'string',
- },
- },
- },
- path: '/accounts/{account_id}/env',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- description: 'Environment variable model definition',
- properties: {
- is_secret: {
- description: 'Secret values are only readable by code running on Netlify’s systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret. (Enterprise plans only)',
- type: 'boolean',
- },
- key: {
- description: 'The environment variable key, like ALGOLIA_ID (case-sensitive)',
- type: 'string',
- 'x-faker': 'commerce.productName',
- },
- scopes: {
- description: 'The scopes that this environment variable is set to',
- items: {
- enum: [
- 'builds',
- 'functions',
- 'runtime',
- 'post-processing',
- ],
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- description: 'The timestamp of when the value was last updated',
- format: 'date-time',
- type: 'string',
- 'x-faker': 'date.past',
- },
- updated_by: {
- properties: {
- avatar_url: {
- description: 'A URL pointing to the user\'s avatar',
- type: 'string',
- 'x-faker': 'internet.avatar',
- },
- email: {
- description: 'The user\'s email address',
- type: 'string',
- 'x-faker': 'internet.email',
- },
- full_name: {
- description: 'The user\'s full name (first and last)',
- type: 'string',
- 'x-faker': 'name.findName',
- },
- id: {
- description: 'The user\'s unique identifier',
- type: 'string',
- 'x-faker': 'datatype.number',
- },
- },
- type: 'object',
- },
- values: {
- description: 'An array of Value objects containing values and metadata',
- items: {
- description: 'Environment variable value model definition',
- properties: {
- context: {
- description: 'The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`.',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- 'branch',
- ],
- type: 'string',
- },
- context_parameter: {
- description: 'An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`.',
- type: 'string',
- },
- id: {
- description: 'The environment variable value\'s universally unique ID',
- type: 'string',
- 'x-faker': 'datatype.uuid',
- },
- value: {
- description: 'The environment variable\'s unencrypted value',
- type: 'string',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'environmentVariables',
- ],
- verb: 'get',
- },
- {
- description: 'Creates new environment variables. Granular scopes are available on Pro plans and above. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI.',
- operationId: 'createEnvVars',
- parameters: {
- body: {
- env_vars: {
- in: 'body',
- name: 'env_vars',
- schema: {
- items: {
- properties: {
- is_secret: {
- description: 'Secret values are only readable by code running on Netlify’s systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret. (Enterprise plans only)',
- type: 'boolean',
- },
- key: {
- description: 'The existing or new name of the key, if you wish to rename it (case-sensitive)',
- type: 'string',
- },
- scopes: {
- description: 'The scopes that this environment variable is set to (Pro plans and above)',
- items: {
- enum: [
- 'builds',
- 'functions',
- 'runtime',
- 'post-processing',
- ],
- type: 'string',
- },
- type: 'array',
- },
- values: {
- items: {
- description: 'Environment variable value model definition',
- properties: {
- context: {
- description: 'The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`.',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- 'branch',
- ],
- type: 'string',
- },
- context_parameter: {
- description: 'An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`.',
- type: 'string',
- },
- id: {
- description: 'The environment variable value\'s universally unique ID',
- type: 'string',
- 'x-faker': 'datatype.uuid',
- },
- value: {
- description: 'The environment variable\'s unencrypted value',
- type: 'string',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- },
- path: {
- account_id: {
- description: 'Scope response to account_id',
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- site_id: {
- description: 'If provided, create an environment variable on the site level, not the account level',
- in: 'query',
- name: 'site_id',
- required: false,
- type: 'string',
- },
- },
- },
- path: '/accounts/{account_id}/env',
- responses: {
- 201: {
- description: 'OK',
- schema: {
- items: {
- description: 'Environment variable model definition',
- properties: {
- is_secret: {
- description: 'Secret values are only readable by code running on Netlify’s systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret. (Enterprise plans only)',
- type: 'boolean',
- },
- key: {
- description: 'The environment variable key, like ALGOLIA_ID (case-sensitive)',
- type: 'string',
- 'x-faker': 'commerce.productName',
- },
- scopes: {
- description: 'The scopes that this environment variable is set to',
- items: {
- enum: [
- 'builds',
- 'functions',
- 'runtime',
- 'post-processing',
- ],
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- description: 'The timestamp of when the value was last updated',
- format: 'date-time',
- type: 'string',
- 'x-faker': 'date.past',
- },
- updated_by: {
- properties: {
- avatar_url: {
- description: 'A URL pointing to the user\'s avatar',
- type: 'string',
- 'x-faker': 'internet.avatar',
- },
- email: {
- description: 'The user\'s email address',
- type: 'string',
- 'x-faker': 'internet.email',
- },
- full_name: {
- description: 'The user\'s full name (first and last)',
- type: 'string',
- 'x-faker': 'name.findName',
- },
- id: {
- description: 'The user\'s unique identifier',
- type: 'string',
- 'x-faker': 'datatype.number',
- },
- },
- type: 'object',
- },
- values: {
- description: 'An array of Value objects containing values and metadata',
- items: {
- description: 'Environment variable value model definition',
- properties: {
- context: {
- description: 'The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`.',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- 'branch',
- ],
- type: 'string',
- },
- context_parameter: {
- description: 'An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`.',
- type: 'string',
- },
- id: {
- description: 'The environment variable value\'s universally unique ID',
- type: 'string',
- 'x-faker': 'datatype.uuid',
- },
- value: {
- description: 'The environment variable\'s unencrypted value',
- type: 'string',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'environmentVariables',
- ],
- verb: 'post',
- },
- {
- description: 'Returns all environment variables for a site. This convenience method behaves the same as `getEnvVars` but doesn\'t require an `account_id` as input.',
- operationId: 'getSiteEnvVars',
- parameters: {
- body: {},
- path: {
- site_id: {
- description: 'Scope response to site_id',
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- context_name: {
- description: 'Filter by deploy context',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- ],
- in: 'query',
- name: 'context_name',
- required: false,
- type: 'string',
- },
- scope: {
- description: 'Filter by scope',
- enum: [
- 'builds',
- 'functions',
- 'runtime',
- 'post_processing',
- ],
- in: 'query',
- name: 'scope',
- required: false,
- type: 'string',
- },
- },
- },
- path: '/api/v1/sites/{site_id}/env',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- description: 'Environment variable model definition',
- properties: {
- is_secret: {
- description: 'Secret values are only readable by code running on Netlify’s systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret. (Enterprise plans only)',
- type: 'boolean',
- },
- key: {
- description: 'The environment variable key, like ALGOLIA_ID (case-sensitive)',
- type: 'string',
- 'x-faker': 'commerce.productName',
- },
- scopes: {
- description: 'The scopes that this environment variable is set to',
- items: {
- enum: [
- 'builds',
- 'functions',
- 'runtime',
- 'post-processing',
- ],
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- description: 'The timestamp of when the value was last updated',
- format: 'date-time',
- type: 'string',
- 'x-faker': 'date.past',
- },
- updated_by: {
- properties: {
- avatar_url: {
- description: 'A URL pointing to the user\'s avatar',
- type: 'string',
- 'x-faker': 'internet.avatar',
- },
- email: {
- description: 'The user\'s email address',
- type: 'string',
- 'x-faker': 'internet.email',
- },
- full_name: {
- description: 'The user\'s full name (first and last)',
- type: 'string',
- 'x-faker': 'name.findName',
- },
- id: {
- description: 'The user\'s unique identifier',
- type: 'string',
- 'x-faker': 'datatype.number',
- },
- },
- type: 'object',
- },
- values: {
- description: 'An array of Value objects containing values and metadata',
- items: {
- description: 'Environment variable value model definition',
- properties: {
- context: {
- description: 'The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`.',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- 'branch',
- ],
- type: 'string',
- },
- context_parameter: {
- description: 'An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`.',
- type: 'string',
- },
- id: {
- description: 'The environment variable value\'s universally unique ID',
- type: 'string',
- 'x-faker': 'datatype.uuid',
- },
- value: {
- description: 'The environment variable\'s unencrypted value',
- type: 'string',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'environmentVariables',
- ],
- verb: 'get',
- },
- {
- description: 'Returns an individual environment variable. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI.',
- operationId: 'getEnvVar',
- parameters: {
- body: {},
- path: {
- account_id: {
- description: 'Scope response to account_id',
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- key: {
- description: 'The environment variable key (case-sensitive)',
- in: 'path',
- name: 'key',
- required: true,
- type: 'string',
- },
- },
- query: {
- site_id: {
- description: 'If provided, return the environment variable for a specific site (no merging is performed)',
- in: 'query',
- name: 'site_id',
- required: false,
- type: 'string',
- },
- },
- },
- path: '/accounts/{account_id}/env/{key}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- description: 'Environment variable model definition',
- properties: {
- is_secret: {
- description: 'Secret values are only readable by code running on Netlify’s systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret. (Enterprise plans only)',
- type: 'boolean',
- },
- key: {
- description: 'The environment variable key, like ALGOLIA_ID (case-sensitive)',
- type: 'string',
- 'x-faker': 'commerce.productName',
- },
- scopes: {
- description: 'The scopes that this environment variable is set to',
- items: {
- enum: [
- 'builds',
- 'functions',
- 'runtime',
- 'post-processing',
- ],
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- description: 'The timestamp of when the value was last updated',
- format: 'date-time',
- type: 'string',
- 'x-faker': 'date.past',
- },
- updated_by: {
- properties: {
- avatar_url: {
- description: 'A URL pointing to the user\'s avatar',
- type: 'string',
- 'x-faker': 'internet.avatar',
- },
- email: {
- description: 'The user\'s email address',
- type: 'string',
- 'x-faker': 'internet.email',
- },
- full_name: {
- description: 'The user\'s full name (first and last)',
- type: 'string',
- 'x-faker': 'name.findName',
- },
- id: {
- description: 'The user\'s unique identifier',
- type: 'string',
- 'x-faker': 'datatype.number',
- },
- },
- type: 'object',
- },
- values: {
- description: 'An array of Value objects containing values and metadata',
- items: {
- description: 'Environment variable value model definition',
- properties: {
- context: {
- description: 'The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`.',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- 'branch',
- ],
- type: 'string',
- },
- context_parameter: {
- description: 'An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`.',
- type: 'string',
- },
- id: {
- description: 'The environment variable value\'s universally unique ID',
- type: 'string',
- 'x-faker': 'datatype.uuid',
- },
- value: {
- description: 'The environment variable\'s unencrypted value',
- type: 'string',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'environmentVariables',
- ],
- verb: 'get',
- },
- {
- description: 'Updates an existing environment variable and all of its values. Existing values will be replaced by values provided. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI.',
- operationId: 'updateEnvVar',
- parameters: {
- body: {
- env_var: {
- in: 'body',
- name: 'env_var',
- schema: {
- properties: {
- is_secret: {
- description: 'Secret values are only readable by code running on Netlify’s systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret. (Enterprise plans only)',
- type: 'boolean',
- },
- key: {
- description: 'The existing or new name of the key, if you wish to rename it (case-sensitive)',
- type: 'string',
- },
- scopes: {
- description: 'The scopes that this environment variable is set to (Pro plans and above)',
- items: {
- enum: [
- 'builds',
- 'functions',
- 'runtime',
- 'post-processing',
- ],
- type: 'string',
- },
- type: 'array',
- },
- values: {
- items: {
- description: 'Environment variable value model definition',
- properties: {
- context: {
- description: 'The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`.',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- 'branch',
- ],
- type: 'string',
- },
- context_parameter: {
- description: 'An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`.',
- type: 'string',
- },
- id: {
- description: 'The environment variable value\'s universally unique ID',
- type: 'string',
- 'x-faker': 'datatype.uuid',
- },
- value: {
- description: 'The environment variable\'s unencrypted value',
- type: 'string',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- account_id: {
- description: 'Scope response to account_id',
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- key: {
- description: 'The existing environment variable key name (case-sensitive)',
- in: 'path',
- name: 'key',
- required: true,
- type: 'string',
- },
- },
- query: {
- site_id: {
- description: 'If provided, update an environment variable set on this site',
- in: 'query',
- name: 'site_id',
- required: false,
- type: 'string',
- },
- },
- },
- path: '/accounts/{account_id}/env/{key}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- description: 'Environment variable model definition',
- properties: {
- is_secret: {
- description: 'Secret values are only readable by code running on Netlify’s systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret. (Enterprise plans only)',
- type: 'boolean',
- },
- key: {
- description: 'The environment variable key, like ALGOLIA_ID (case-sensitive)',
- type: 'string',
- 'x-faker': 'commerce.productName',
- },
- scopes: {
- description: 'The scopes that this environment variable is set to',
- items: {
- enum: [
- 'builds',
- 'functions',
- 'runtime',
- 'post-processing',
- ],
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- description: 'The timestamp of when the value was last updated',
- format: 'date-time',
- type: 'string',
- 'x-faker': 'date.past',
- },
- updated_by: {
- properties: {
- avatar_url: {
- description: 'A URL pointing to the user\'s avatar',
- type: 'string',
- 'x-faker': 'internet.avatar',
- },
- email: {
- description: 'The user\'s email address',
- type: 'string',
- 'x-faker': 'internet.email',
- },
- full_name: {
- description: 'The user\'s full name (first and last)',
- type: 'string',
- 'x-faker': 'name.findName',
- },
- id: {
- description: 'The user\'s unique identifier',
- type: 'string',
- 'x-faker': 'datatype.number',
- },
- },
- type: 'object',
- },
- values: {
- description: 'An array of Value objects containing values and metadata',
- items: {
- description: 'Environment variable value model definition',
- properties: {
- context: {
- description: 'The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`.',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- 'branch',
- ],
- type: 'string',
- },
- context_parameter: {
- description: 'An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`.',
- type: 'string',
- },
- id: {
- description: 'The environment variable value\'s universally unique ID',
- type: 'string',
- 'x-faker': 'datatype.uuid',
- },
- value: {
- description: 'The environment variable\'s unencrypted value',
- type: 'string',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'environmentVariables',
- ],
- verb: 'put',
- },
- {
- description: 'Updates or creates a new value for an existing environment variable. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI.',
- operationId: 'setEnvVarValue',
- parameters: {
- body: {
- env_var: {
- in: 'body',
- name: 'env_var',
- schema: {
- properties: {
- context: {
- description: 'The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`. `branch` must be provided with a value in `context_parameter`.',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- 'branch',
- ],
- type: 'string',
- },
- context_parameter: {
- description: 'An additional parameter for custom branches. Currently, this is used for providing a branch name when `context=branch`.',
- type: 'string',
- },
- value: {
- description: 'The environment variable\'s unencrypted value',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- account_id: {
- description: 'Scope response to account_id',
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- key: {
- description: 'The existing environment variable key name (case-sensitive)',
- in: 'path',
- name: 'key',
- required: true,
- type: 'string',
- },
- },
- query: {
- site_id: {
- description: 'If provided, update an environment variable set on this site',
- in: 'query',
- name: 'site_id',
- type: 'string',
- },
- },
- },
- path: '/accounts/{account_id}/env/{key}',
- responses: {
- 201: {
- description: 'Created (success)',
- schema: {
- description: 'Environment variable model definition',
- properties: {
- is_secret: {
- description: 'Secret values are only readable by code running on Netlify’s systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret. (Enterprise plans only)',
- type: 'boolean',
- },
- key: {
- description: 'The environment variable key, like ALGOLIA_ID (case-sensitive)',
- type: 'string',
- 'x-faker': 'commerce.productName',
- },
- scopes: {
- description: 'The scopes that this environment variable is set to',
- items: {
- enum: [
- 'builds',
- 'functions',
- 'runtime',
- 'post-processing',
- ],
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- description: 'The timestamp of when the value was last updated',
- format: 'date-time',
- type: 'string',
- 'x-faker': 'date.past',
- },
- updated_by: {
- properties: {
- avatar_url: {
- description: 'A URL pointing to the user\'s avatar',
- type: 'string',
- 'x-faker': 'internet.avatar',
- },
- email: {
- description: 'The user\'s email address',
- type: 'string',
- 'x-faker': 'internet.email',
- },
- full_name: {
- description: 'The user\'s full name (first and last)',
- type: 'string',
- 'x-faker': 'name.findName',
- },
- id: {
- description: 'The user\'s unique identifier',
- type: 'string',
- 'x-faker': 'datatype.number',
- },
- },
- type: 'object',
- },
- values: {
- description: 'An array of Value objects containing values and metadata',
- items: {
- description: 'Environment variable value model definition',
- properties: {
- context: {
- description: 'The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`.',
- enum: [
- 'all',
- 'dev',
- 'branch-deploy',
- 'deploy-preview',
- 'production',
- 'branch',
- ],
- type: 'string',
- },
- context_parameter: {
- description: 'An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`.',
- type: 'string',
- },
- id: {
- description: 'The environment variable value\'s universally unique ID',
- type: 'string',
- 'x-faker': 'datatype.uuid',
- },
- value: {
- description: 'The environment variable\'s unencrypted value',
- type: 'string',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- type: 'array',
- 'x-faker': 'internet.password',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'environmentVariables',
- ],
- verb: 'patch',
- },
- {
- description: 'Deletes an environment variable. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI.',
- operationId: 'deleteEnvVar',
- parameters: {
- body: {},
- path: {
- account_id: {
- description: 'Scope response to account_id',
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- key: {
- description: 'The environment variable key (case-sensitive)',
- in: 'path',
- name: 'key',
- required: true,
- type: 'string',
- },
- },
- query: {
- site_id: {
- description: 'If provided, delete the environment variable from this site',
- in: 'query',
- name: 'site_id',
- required: false,
- type: 'string',
- },
- },
- },
- path: '/accounts/{account_id}/env/{key}',
- responses: {
- 204: {
- description: 'No Content (success)',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'environmentVariables',
- ],
- verb: 'delete',
- },
- {
- description: 'Deletes a specific environment variable value. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI.',
- operationId: 'deleteEnvVarValue',
- parameters: {
- body: {},
- path: {
- account_id: {
- description: 'Scope response to account_id',
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- id: {
- description: 'The environment variable value\'s ID',
- in: 'path',
- name: 'id',
- required: true,
- type: 'string',
- },
- key: {
- description: 'The environment variable key name (case-sensitive)',
- in: 'path',
- name: 'key',
- required: true,
- type: 'string',
- },
- },
- query: {
- site_id: {
- description: 'If provided, delete the value from an environment variable on this site',
- in: 'query',
- name: 'site_id',
- required: false,
- type: 'string',
- },
- },
- },
- path: '/accounts/{account_id}/env/{key}/value/{id}',
- responses: {
- 204: {
- description: 'No Content (success)',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'environmentVariables',
- ],
- verb: 'delete',
- },
- {
- operationId: 'searchSiteFunctions',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- filter: {
- in: 'query',
- name: 'filter',
- required: false,
- type: 'string',
- },
- },
- },
- path: '/sites/{site_id}/functions',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- branch: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- functions: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- log_type: {
- type: 'string',
- },
- provider: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'function',
- ],
- verb: 'get',
- },
- {
- operationId: 'listSiteForms',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/forms',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- fields: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- paths: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- site_id: {
- type: 'string',
- },
- submission_count: {
- format: 'int32',
- type: 'integer',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'form',
- ],
- verb: 'get',
- },
- {
- operationId: 'deleteSiteForm',
- parameters: {
- body: {},
- path: {
- form_id: {
- in: 'path',
- name: 'form_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/forms/{form_id}',
- responses: {
- 204: {
- description: 'Deleted',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'form',
- ],
- verb: 'delete',
- },
- {
- operationId: 'listSiteSubmissions',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- page: {
- format: 'int32',
- in: 'query',
- name: 'page',
- required: false,
- type: 'integer',
- },
- per_page: {
- format: 'int32',
- in: 'query',
- name: 'per_page',
- required: false,
- type: 'integer',
- },
- },
- },
- path: '/sites/{site_id}/submissions',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- body: {
- type: 'string',
- },
- company: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- type: 'object',
- },
- email: {
- type: 'string',
- },
- first_name: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- last_name: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- number: {
- format: 'int32',
- type: 'integer',
- },
- site_url: {
- type: 'string',
- },
- summary: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'submission',
- ],
- verb: 'get',
- },
- {
- operationId: 'listSiteFiles',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/files',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- id: {
- type: 'string',
- },
- mime_type: {
- type: 'string',
- },
- path: {
- type: 'string',
- },
- sha: {
- type: 'string',
- },
- size: {
- format: 'int64',
- type: 'integer',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'file',
- ],
- verb: 'get',
- },
- {
- operationId: 'listSiteAssets',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/assets',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- content_type: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- creator_id: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- key: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- size: {
- format: 'int64',
- type: 'integer',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- visibility: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'asset',
- ],
- verb: 'get',
- },
- {
- operationId: 'createSiteAsset',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- content_type: {
- in: 'query',
- name: 'content_type',
- required: true,
- type: 'string',
- },
- name: {
- in: 'query',
- name: 'name',
- required: true,
- type: 'string',
- },
- size: {
- format: 'int64',
- in: 'query',
- name: 'size',
- required: true,
- type: 'integer',
- },
- visibility: {
- in: 'query',
- name: 'visibility',
- type: 'string',
- },
- },
- },
- path: '/sites/{site_id}/assets',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- asset: {
- properties: {
- content_type: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- creator_id: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- key: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- size: {
- format: 'int64',
- type: 'integer',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- visibility: {
- type: 'string',
- },
- },
- type: 'object',
- },
- form: {
- properties: {
- fields: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'asset',
- ],
- verb: 'post',
- },
- {
- operationId: 'getSiteAssetInfo',
- parameters: {
- body: {},
- path: {
- asset_id: {
- in: 'path',
- name: 'asset_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/assets/{asset_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- content_type: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- creator_id: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- key: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- size: {
- format: 'int64',
- type: 'integer',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- visibility: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'asset',
- ],
- verb: 'get',
- },
- {
- operationId: 'updateSiteAsset',
- parameters: {
- body: {},
- path: {
- asset_id: {
- in: 'path',
- name: 'asset_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- state: {
- in: 'query',
- name: 'state',
- required: true,
- type: 'string',
- },
- },
- },
- path: '/sites/{site_id}/assets/{asset_id}',
- responses: {
- 200: {
- description: 'Updated',
- schema: {
- properties: {
- content_type: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- creator_id: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- key: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- size: {
- format: 'int64',
- type: 'integer',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- visibility: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'asset',
- ],
- verb: 'put',
- },
- {
- operationId: 'deleteSiteAsset',
- parameters: {
- body: {},
- path: {
- asset_id: {
- in: 'path',
- name: 'asset_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/assets/{asset_id}',
- responses: {
- 204: {
- description: 'Deleted',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'asset',
- ],
- verb: 'delete',
- },
- {
- operationId: 'getSiteAssetPublicSignature',
- parameters: {
- body: {},
- path: {
- asset_id: {
- in: 'path',
- name: 'asset_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/assets/{asset_id}/public_signature',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'assetPublicSignature',
- ],
- verb: 'get',
- },
- {
- operationId: 'getSiteFileByPathName',
- parameters: {
- body: {},
- path: {
- file_path: {
- in: 'path',
- name: 'file_path',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/files/{file_path}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- id: {
- type: 'string',
- },
- mime_type: {
- type: 'string',
- },
- path: {
- type: 'string',
- },
- sha: {
- type: 'string',
- },
- size: {
- format: 'int64',
- type: 'integer',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'file',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- description: 'Purges cached content from Netlify\'s CDN. Supports purging by Cache-Tag.',
- operationId: 'purgeCache',
- parameters: {
- body: {
- payload: {
- in: 'body',
- name: 'payload',
- required: true,
- schema: {
- properties: {
- cache_tags: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- site_id: {
- type: 'string',
- },
- site_slug: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {},
- query: {},
- },
- path: '/purge',
- responses: {
- 202: {
- description: 'OK',
- },
- 400: {
- description: 'Invalid request parameters',
- },
- 404: {
- description: 'Site not found',
- },
- },
- tags: [
- 'purge',
- ],
- verb: 'post',
- },
- {
- operationId: 'listSiteSnippets',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/snippets',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- general: {
- type: 'string',
- },
- general_position: {
- type: 'string',
- },
- goal: {
- type: 'string',
- },
- goal_position: {
- type: 'string',
- },
- id: {
- format: 'int32',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'snippet',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'createSiteSnippet',
- parameters: {
- body: {
- snippet: {
- in: 'body',
- name: 'snippet',
- required: true,
- schema: {
- properties: {
- general: {
- type: 'string',
- },
- general_position: {
- type: 'string',
- },
- goal: {
- type: 'string',
- },
- goal_position: {
- type: 'string',
- },
- id: {
- format: 'int32',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/snippets',
- responses: {
- 201: {
- description: 'OK',
- schema: {
- properties: {
- general: {
- type: 'string',
- },
- general_position: {
- type: 'string',
- },
- goal: {
- type: 'string',
- },
- goal_position: {
- type: 'string',
- },
- id: {
- format: 'int32',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'snippet',
- ],
- verb: 'post',
- },
- {
- operationId: 'getSiteSnippet',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- snippet_id: {
- in: 'path',
- name: 'snippet_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/snippets/{snippet_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- general: {
- type: 'string',
- },
- general_position: {
- type: 'string',
- },
- goal: {
- type: 'string',
- },
- goal_position: {
- type: 'string',
- },
- id: {
- format: 'int32',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'snippet',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'updateSiteSnippet',
- parameters: {
- body: {
- snippet: {
- in: 'body',
- name: 'snippet',
- required: true,
- schema: {
- properties: {
- general: {
- type: 'string',
- },
- general_position: {
- type: 'string',
- },
- goal: {
- type: 'string',
- },
- goal_position: {
- type: 'string',
- },
- id: {
- format: 'int32',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- snippet_id: {
- in: 'path',
- name: 'snippet_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/snippets/{snippet_id}',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'snippet',
- ],
- verb: 'put',
- },
- {
- operationId: 'deleteSiteSnippet',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- snippet_id: {
- in: 'path',
- name: 'snippet_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/snippets/{snippet_id}',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'snippet',
- ],
- verb: 'delete',
- },
- {
- operationId: 'getSiteMetadata',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/metadata',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'metadata',
- ],
- verb: 'get',
- },
- {
- operationId: 'updateSiteMetadata',
- parameters: {
- body: {
- metadata: {
- in: 'body',
- name: 'metadata',
- required: true,
- schema: {
- type: 'object',
- },
- },
- },
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/metadata',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'metadata',
- ],
- verb: 'put',
- },
- {
- operationId: 'listSiteBuildHooks',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/build_hooks',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- branch: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'buildHook',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'createSiteBuildHook',
- parameters: {
- body: {
- buildHook: {
- in: 'body',
- name: 'buildHook',
- required: true,
- schema: {
- properties: {
- branch: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/build_hooks',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- branch: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'buildHook',
- ],
- verb: 'post',
- },
- {
- operationId: 'getSiteBuildHook',
- parameters: {
- body: {},
- path: {
- id: {
- in: 'path',
- name: 'id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/build_hooks/{id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- branch: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'buildHook',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'updateSiteBuildHook',
- parameters: {
- body: {
- buildHook: {
- in: 'body',
- name: 'buildHook',
- required: true,
- schema: {
- properties: {
- branch: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- id: {
- in: 'path',
- name: 'id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/build_hooks/{id}',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'buildHook',
- ],
- verb: 'put',
- },
- {
- operationId: 'deleteSiteBuildHook',
- parameters: {
- body: {},
- path: {
- id: {
- in: 'path',
- name: 'id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/build_hooks/{id}',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'buildHook',
- ],
- verb: 'delete',
- },
- {
- operationId: 'listSiteDeploys',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- branch: {
- in: 'query',
- name: 'branch',
- type: 'string',
- },
- 'deploy-previews': {
- in: 'query',
- name: 'deploy-previews',
- type: 'boolean',
- },
- 'latest-published': {
- in: 'query',
- name: 'latest-published',
- type: 'boolean',
- },
- page: {
- format: 'int32',
- in: 'query',
- name: 'page',
- required: false,
- type: 'integer',
- },
- per_page: {
- format: 'int32',
- in: 'query',
- name: 'per_page',
- required: false,
- type: 'integer',
- },
- production: {
- in: 'query',
- name: 'production',
- type: 'boolean',
- },
- state: {
- enum: [
- 'new',
- 'pending_review',
- 'accepted',
- 'rejected',
- 'enqueued',
- 'building',
- 'uploading',
- 'uploaded',
- 'preparing',
- 'prepared',
- 'processing',
- 'processed',
- 'ready',
- 'error',
- 'retrying',
- ],
- in: 'query',
- name: 'state',
- type: 'string',
- },
- },
- },
- path: '/sites/{site_id}/deploys',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'get',
- },
- {
- operationId: 'createSiteDeploy',
- parameters: {
- body: {
- deploy: {
- in: 'body',
- name: 'deploy',
- required: true,
- schema: {
- properties: {
- async: {
- type: 'boolean',
- },
- branch: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- files: {
- type: 'object',
- },
- framework: {
- type: 'string',
- },
- framework_version: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- functions: {
- type: 'object',
- },
- functions_config: {
- additionalProperties: {
- properties: {
- build_data: {
- type: 'object',
- },
- display_name: {
- type: 'string',
- },
- generator: {
- type: 'string',
- },
- priority: {
- type: 'integer',
- },
- routes: {
- items: {
- properties: {
- expression: {
- type: 'string',
- },
- literal: {
- type: 'string',
- },
- methods: {
- items: {
- enum: [
- 'GET',
- 'POST',
- 'PUT',
- 'PATCH',
- 'DELETE',
- 'OPTIONS',
- ],
- type: 'string',
- },
- type: 'array',
- },
- pattern: {
- type: 'string',
- },
- prefer_static: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- traffic_rules: {
- properties: {
- action: {
- properties: {
- config: {
- properties: {
- aggregate: {
- properties: {
- keys: {
- items: {
- properties: {
- type: {
- enum: [
- 'ip',
- 'domain',
- ],
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- type: 'object',
- },
- rate_limit_config: {
- properties: {
- algorithm: {
- enum: [
- 'sliding_window',
- ],
- type: 'string',
- },
- window_limit: {
- type: 'integer',
- },
- window_size: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- to: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- branch: {
- in: 'query',
- name: 'branch',
- type: 'string',
- },
- 'deploy-previews': {
- in: 'query',
- name: 'deploy-previews',
- type: 'boolean',
- },
- 'latest-published': {
- in: 'query',
- name: 'latest-published',
- type: 'boolean',
- },
- production: {
- in: 'query',
- name: 'production',
- type: 'boolean',
- },
- state: {
- enum: [
- 'new',
- 'pending_review',
- 'accepted',
- 'rejected',
- 'enqueued',
- 'building',
- 'uploading',
- 'uploaded',
- 'preparing',
- 'prepared',
- 'processing',
- 'processed',
- 'ready',
- 'error',
- 'retrying',
- ],
- in: 'query',
- name: 'state',
- type: 'string',
- },
- title: {
- in: 'query',
- name: 'title',
- type: 'string',
- },
- },
- },
- path: '/sites/{site_id}/deploys',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'post',
- },
- {
- operationId: 'getSiteDeploy',
- parameters: {
- body: {},
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/deploys/{deploy_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'get',
- },
- {
- operationId: 'updateSiteDeploy',
- parameters: {
- body: {
- deploy: {
- in: 'body',
- name: 'deploy',
- required: true,
- schema: {
- properties: {
- async: {
- type: 'boolean',
- },
- branch: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- files: {
- type: 'object',
- },
- framework: {
- type: 'string',
- },
- framework_version: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- functions: {
- type: 'object',
- },
- functions_config: {
- additionalProperties: {
- properties: {
- build_data: {
- type: 'object',
- },
- display_name: {
- type: 'string',
- },
- generator: {
- type: 'string',
- },
- priority: {
- type: 'integer',
- },
- routes: {
- items: {
- properties: {
- expression: {
- type: 'string',
- },
- literal: {
- type: 'string',
- },
- methods: {
- items: {
- enum: [
- 'GET',
- 'POST',
- 'PUT',
- 'PATCH',
- 'DELETE',
- 'OPTIONS',
- ],
- type: 'string',
- },
- type: 'array',
- },
- pattern: {
- type: 'string',
- },
- prefer_static: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- traffic_rules: {
- properties: {
- action: {
- properties: {
- config: {
- properties: {
- aggregate: {
- properties: {
- keys: {
- items: {
- properties: {
- type: {
- enum: [
- 'ip',
- 'domain',
- ],
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- type: 'object',
- },
- rate_limit_config: {
- properties: {
- algorithm: {
- enum: [
- 'sliding_window',
- ],
- type: 'string',
- },
- window_limit: {
- type: 'integer',
- },
- window_size: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- to: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/deploys/{deploy_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'put',
- },
- {
- operationId: 'deleteSiteDeploy',
- parameters: {
- body: {},
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/deploys/{deploy_id}',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'delete',
- },
- {
- operationId: 'cancelSiteDeploy',
- parameters: {
- body: {},
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/deploys/{deploy_id}/cancel',
- responses: {
- 201: {
- description: 'Cancelled',
- schema: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'post',
- },
- {
- operationId: 'restoreSiteDeploy',
- parameters: {
- body: {},
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/deploys/{deploy_id}/restore',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'post',
- },
- {
- operationId: 'listSiteBuilds',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- page: {
- format: 'int32',
- in: 'query',
- name: 'page',
- required: false,
- type: 'integer',
- },
- per_page: {
- format: 'int32',
- in: 'query',
- name: 'per_page',
- required: false,
- type: 'integer',
- },
- },
- },
- path: '/sites/{site_id}/builds',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_id: {
- type: 'string',
- },
- done: {
- type: 'boolean',
- },
- error: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- sha: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'build',
- ],
- verb: 'get',
- },
- {
- operationId: 'createSiteBuild',
- parameters: {
- body: {
- build: {
- in: 'body',
- name: 'build',
- required: false,
- schema: {
- properties: {
- clear_cache: {
- type: 'boolean',
- },
- image: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/builds',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_id: {
- type: 'string',
- },
- done: {
- type: 'boolean',
- },
- error: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- sha: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'build',
- ],
- verb: 'post',
- },
- {
- operationId: 'listSiteDeployedBranches',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/deployed-branches',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- deploy_id: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- slug: {
- type: 'string',
- },
- ssl_url: {
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deployedBranch',
- ],
- verb: 'get',
- },
- {
- description: `[Beta] Unlinks the repo from the site.␊
- ␊
- This action will also:␊
- - Delete associated deploy keys␊
- - Delete outgoing webhooks for the repo␊
- - Delete the site's build hooks`,
- operationId: 'unlinkSiteRepo',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/unlink_repo',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- admin_url: {
- type: 'string',
- },
- branch_deploy_custom_domain: {
- type: 'string',
- },
- build_image: {
- type: 'string',
- },
- build_settings: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- capabilities: {
- additionalProperties: {
- type: 'object',
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- custom_domain: {
- type: 'string',
- },
- default_hooks_data: {
- properties: {
- access_token: {
- type: 'string',
- },
- },
- type: 'object',
- },
- deploy_hook: {
- type: 'string',
- },
- deploy_preview_custom_domain: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- domain_aliases: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- force_ssl: {
- type: 'boolean',
- },
- functions_region: {
- type: 'string',
- },
- git_provider: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- id_domain: {
- type: 'string',
- },
- managed_dns: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- notification_email: {
- type: 'string',
- },
- password: {
- type: 'string',
- },
- plan: {
- type: 'string',
- },
- prerender: {
- type: 'string',
- },
- processing_settings: {
- properties: {
- html: {
- properties: {
- pretty_urls: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- published_deploy: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- screenshot_url: {
- type: 'string',
- },
- session_id: {
- type: 'string',
- },
- ssl: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- 404: {
- description: 'Site not found',
- },
- },
- tags: [
- 'site',
- ],
- verb: 'put',
- },
- {
- operationId: 'getSiteBuild',
- parameters: {
- body: {},
- path: {
- build_id: {
- in: 'path',
- name: 'build_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/builds/{build_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_id: {
- type: 'string',
- },
- done: {
- type: 'boolean',
- },
- error: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- sha: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'build',
- ],
- verb: 'get',
- },
- {
- operationId: 'updateSiteBuildLog',
- parameters: {
- body: {
- msg: {
- in: 'body',
- name: 'msg',
- required: true,
- schema: {
- properties: {
- error: {
- type: 'boolean',
- },
- message: {
- type: 'string',
- },
- section: {
- enum: [
- 'initializing',
- 'building',
- 'deploying',
- 'cleanup',
- 'postprocessing',
- ],
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- build_id: {
- in: 'path',
- name: 'build_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/builds/{build_id}/log',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'buildLogMsg',
- ],
- verb: 'post',
- },
- {
- operationId: 'notifyBuildStart',
- parameters: {
- body: {},
- path: {
- build_id: {
- in: 'path',
- name: 'build_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- build_version: {
- in: 'query',
- name: 'build_version',
- required: false,
- type: 'string',
- },
- buildbot_version: {
- in: 'query',
- name: 'buildbot_version',
- required: false,
- type: 'string',
- },
- },
- },
- path: '/builds/{build_id}/start',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'build',
- ],
- verb: 'post',
- },
- {
- operationId: 'getAccountBuildStatus',
- parameters: {
- body: {},
- path: {
- account_id: {
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/{account_id}/builds/status',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- active: {
- type: 'integer',
- },
- build_count: {
- type: 'integer',
- },
- enqueued: {
- type: 'integer',
- },
- minutes: {
- properties: {
- current: {
- type: 'integer',
- },
- current_average_sec: {
- type: 'integer',
- },
- included_minutes: {
- type: 'string',
- },
- included_minutes_with_packs: {
- type: 'string',
- },
- last_updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- period_end_date: {
- format: 'dateTime',
- type: 'string',
- },
- period_start_date: {
- format: 'dateTime',
- type: 'string',
- },
- previous: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- pending_concurrency: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'build',
- ],
- verb: 'get',
- },
- {
- operationId: 'getDNSForSite',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/dns',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- account_id: {
- type: 'string',
- },
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- dedicated: {
- type: 'boolean',
- },
- dns_servers: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- domain: {
- type: 'string',
- },
- errors: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- ipv6_enabled: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- records: {
- items: {
- properties: {
- dns_zone_id: {
- type: 'string',
- },
- flag: {
- type: 'integer',
- },
- hostname: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- managed: {
- type: 'boolean',
- },
- priority: {
- format: 'int64',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- tag: {
- type: 'string',
- },
- ttl: {
- format: 'int64',
- type: 'integer',
- },
- type: {
- type: 'string',
- },
- value: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- site_id: {
- type: 'string',
- },
- supported_record_types: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'get',
- },
- {
- operationId: 'configureDNSForSite',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/dns',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- account_id: {
- type: 'string',
- },
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- dedicated: {
- type: 'boolean',
- },
- dns_servers: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- domain: {
- type: 'string',
- },
- errors: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- ipv6_enabled: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- records: {
- items: {
- properties: {
- dns_zone_id: {
- type: 'string',
- },
- flag: {
- type: 'integer',
- },
- hostname: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- managed: {
- type: 'boolean',
- },
- priority: {
- format: 'int64',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- tag: {
- type: 'string',
- },
- ttl: {
- format: 'int64',
- type: 'integer',
- },
- type: {
- type: 'string',
- },
- value: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- site_id: {
- type: 'string',
- },
- supported_record_types: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'put',
- },
- {
- operationId: 'rollbackSiteDeploy',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/rollback',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'put',
- },
- {
- operationId: 'getDeploy',
- parameters: {
- body: {},
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/deploys/{deploy_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'get',
- },
- {
- operationId: 'deleteDeploy',
- parameters: {
- body: {},
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/deploys/{deploy_id}',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'delete',
- },
- {
- operationId: 'lockDeploy',
- parameters: {
- body: {},
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/deploys/{deploy_id}/lock',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'post',
- },
- {
- operationId: 'unlockDeploy',
- parameters: {
- body: {},
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/deploys/{deploy_id}/unlock',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deploy',
- ],
- verb: 'post',
- },
- {
- consumes: [
- 'application/octet-stream',
- ],
- operationId: 'uploadDeployFile',
- parameters: {
- body: {
- file_body: {
- in: 'body',
- name: 'file_body',
- required: true,
- schema: {
- format: 'binary',
- type: 'string',
- },
- },
- },
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- path: {
- in: 'path',
- name: 'path',
- required: true,
- type: 'string',
- },
- },
- query: {
- size: {
- in: 'query',
- name: 'size',
- type: 'integer',
- },
- },
- },
- path: '/deploys/{deploy_id}/files/{path}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- id: {
- type: 'string',
- },
- mime_type: {
- type: 'string',
- },
- path: {
- type: 'string',
- },
- sha: {
- type: 'string',
- },
- size: {
- format: 'int64',
- type: 'integer',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'file',
- ],
- verb: 'put',
- },
- {
- consumes: [
- 'application/octet-stream',
- ],
- operationId: 'uploadDeployFunction',
- parameters: {
- body: {
- file_body: {
- in: 'body',
- name: 'file_body',
- required: true,
- schema: {
- format: 'binary',
- type: 'string',
- },
- },
- },
- header: {
- 'X-Nf-Retry-Count': {
- in: 'header',
- name: 'X-Nf-Retry-Count',
- type: 'integer',
- },
- },
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- name: {
- in: 'path',
- name: 'name',
- required: true,
- type: 'string',
- },
- },
- query: {
- invocation_mode: {
- in: 'query',
- name: 'invocation_mode',
- type: 'string',
- },
- runtime: {
- in: 'query',
- name: 'runtime',
- type: 'string',
- },
- size: {
- in: 'query',
- name: 'size',
- type: 'integer',
- },
- timeout: {
- in: 'query',
- name: 'timeout',
- type: 'integer',
- },
- },
- },
- path: '/deploys/{deploy_id}/functions/{name}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- sha: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'function',
- ],
- verb: 'put',
- },
- {
- description: 'This is an internal-only endpoint.',
- operationId: 'updatePlugin',
- parameters: {
- body: {
- plugin_params: {
- in: 'body',
- name: 'plugin_params',
- schema: {
- properties: {
- pinned_version: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- package: {
- in: 'path',
- name: 'package',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/plugins/{package}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- package: {
- type: 'string',
- },
- pinned_version: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'x-internal',
- ],
- verb: 'put',
- 'x-internal': true,
- },
- {
- description: 'This is an internal-only endpoint.',
- operationId: 'getLatestPluginRuns',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- packages: {
- in: 'query',
- items: {
- type: 'string',
- },
- name: 'packages',
- required: true,
- type: 'array',
- },
- state: {
- in: 'query',
- name: 'state',
- type: 'string',
- },
- },
- },
- path: '/sites/{site_id}/plugin_runs/latest',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- allOf: [
- {
- properties: {
- package: {
- type: 'string',
- },
- reporting_event: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- summary: {
- type: 'string',
- },
- text: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- version: {
- type: 'string',
- },
- },
- type: 'object',
- },
- {
- properties: {
- deploy_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- ],
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'x-internal',
- ],
- verb: 'get',
- 'x-internal': true,
- },
- {
- description: 'This is an internal-only endpoint.',
- operationId: 'createPluginRun',
- parameters: {
- body: {
- plugin_run: {
- in: 'body',
- name: 'plugin_run',
- schema: {
- properties: {
- package: {
- type: 'string',
- },
- reporting_event: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- summary: {
- type: 'string',
- },
- text: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- version: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- deploy_id: {
- in: 'path',
- name: 'deploy_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/deploys/{deploy_id}/plugin_runs',
- responses: {
- 201: {
- description: 'CREATED',
- schema: {
- allOf: [
- {
- properties: {
- package: {
- type: 'string',
- },
- reporting_event: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- summary: {
- type: 'string',
- },
- text: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- version: {
- type: 'string',
- },
- },
- type: 'object',
- },
- {
- properties: {
- deploy_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- ],
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'x-internal',
- ],
- verb: 'post',
- 'x-internal': true,
- },
- {
- operationId: 'listFormSubmissions',
- parameters: {
- body: {},
- path: {
- form_id: {
- in: 'path',
- name: 'form_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- page: {
- format: 'int32',
- in: 'query',
- name: 'page',
- required: false,
- type: 'integer',
- },
- per_page: {
- format: 'int32',
- in: 'query',
- name: 'per_page',
- required: false,
- type: 'integer',
- },
- },
- },
- path: '/forms/{form_id}/submissions',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- body: {
- type: 'string',
- },
- company: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- type: 'object',
- },
- email: {
- type: 'string',
- },
- first_name: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- last_name: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- number: {
- format: 'int32',
- type: 'integer',
- },
- site_url: {
- type: 'string',
- },
- summary: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'submission',
- ],
- verb: 'get',
- },
- {
- operationId: 'listHooksBySiteId',
- parameters: {
- body: {},
- path: {},
- query: {
- site_id: {
- in: 'query',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- },
- path: '/hooks',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- type: 'object',
- },
- disabled: {
- type: 'boolean',
- },
- event: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'hook',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'createHookBySiteId',
- parameters: {
- body: {
- hook: {
- in: 'body',
- name: 'hook',
- required: true,
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- type: 'object',
- },
- disabled: {
- type: 'boolean',
- },
- event: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {},
- query: {
- site_id: {
- in: 'query',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- },
- path: '/hooks',
- responses: {
- 201: {
- description: 'OK',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- type: 'object',
- },
- disabled: {
- type: 'boolean',
- },
- event: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'hook',
- ],
- verb: 'post',
- },
- {
- operationId: 'getHook',
- parameters: {
- body: {},
- path: {
- hook_id: {
- in: 'path',
- name: 'hook_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/hooks/{hook_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- type: 'object',
- },
- disabled: {
- type: 'boolean',
- },
- event: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'hook',
- ],
- verb: 'get',
- },
- {
- operationId: 'updateHook',
- parameters: {
- body: {
- hook: {
- in: 'body',
- name: 'hook',
- required: true,
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- type: 'object',
- },
- disabled: {
- type: 'boolean',
- },
- event: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- hook_id: {
- in: 'path',
- name: 'hook_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/hooks/{hook_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- type: 'object',
- },
- disabled: {
- type: 'boolean',
- },
- event: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'hook',
- ],
- verb: 'put',
- },
- {
- operationId: 'deleteHook',
- parameters: {
- body: {},
- path: {
- hook_id: {
- in: 'path',
- name: 'hook_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/hooks/{hook_id}',
- responses: {
- 204: {
- description: 'No content',
- },
- },
- tags: [
- 'hook',
- ],
- verb: 'delete',
- },
- {
- operationId: 'enableHook',
- parameters: {
- body: {},
- path: {
- hook_id: {
- in: 'path',
- name: 'hook_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/hooks/{hook_id}/enable',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- type: 'object',
- },
- disabled: {
- type: 'boolean',
- },
- event: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'hook',
- ],
- verb: 'post',
- },
- {
- operationId: 'listHookTypes',
- parameters: {
- body: {},
- path: {},
- query: {},
- },
- path: '/hooks/types',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- events: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- fields: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'hookType',
- ],
- verb: 'get',
- },
- {
- operationId: 'createTicket',
- parameters: {
- body: {},
- path: {},
- query: {
- client_id: {
- in: 'query',
- name: 'client_id',
- required: true,
- type: 'string',
- },
- },
- },
- path: '/oauth/tickets',
- responses: {
- 201: {
- description: 'ok',
- schema: {
- properties: {
- authorized: {
- type: 'boolean',
- },
- client_id: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'ticket',
- ],
- verb: 'post',
- },
- {
- operationId: 'showTicket',
- parameters: {
- body: {},
- path: {
- ticket_id: {
- in: 'path',
- name: 'ticket_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/oauth/tickets/{ticket_id}',
- responses: {
- 200: {
- description: 'ok',
- schema: {
- properties: {
- authorized: {
- type: 'boolean',
- },
- client_id: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'ticket',
- ],
- verb: 'get',
- },
- {
- operationId: 'exchangeTicket',
- parameters: {
- body: {},
- path: {
- ticket_id: {
- in: 'path',
- name: 'ticket_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/oauth/tickets/{ticket_id}/exchange',
- responses: {
- 201: {
- description: 'ok',
- schema: {
- properties: {
- access_token: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- user_email: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'accessToken',
- ],
- verb: 'post',
- },
- {
- operationId: 'listDeployKeys',
- parameters: {
- body: {},
- path: {},
- query: {},
- },
- path: '/deploy_keys',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- public_key: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deployKey',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'createDeployKey',
- parameters: {
- body: {},
- path: {},
- query: {},
- },
- path: '/deploy_keys',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- public_key: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deployKey',
- ],
- verb: 'post',
- },
- {
- operationId: 'getDeployKey',
- parameters: {
- body: {},
- path: {
- key_id: {
- in: 'path',
- name: 'key_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/deploy_keys/{key_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- public_key: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deployKey',
- ],
- verb: 'get',
- },
- {
- operationId: 'deleteDeployKey',
- parameters: {
- body: {},
- path: {
- key_id: {
- in: 'path',
- name: 'key_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/deploy_keys/{key_id}',
- responses: {
- 204: {
- description: 'Not Content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'deployKey',
- ],
- verb: 'delete',
- },
- {
- consumes: [
- 'application/json',
- ],
- description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment variables for a site.',
- operationId: 'createSiteInTeam',
- parameters: {
- body: {
- site: {
- in: 'body',
- name: 'site',
- schema: {
- allOf: [
- {
- properties: {
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- admin_url: {
- type: 'string',
- },
- branch_deploy_custom_domain: {
- type: 'string',
- },
- build_image: {
- type: 'string',
- },
- build_settings: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- capabilities: {
- additionalProperties: {
- type: 'object',
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- custom_domain: {
- type: 'string',
- },
- default_hooks_data: {
- properties: {
- access_token: {
- type: 'string',
- },
- },
- type: 'object',
- },
- deploy_hook: {
- type: 'string',
- },
- deploy_preview_custom_domain: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- domain_aliases: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- force_ssl: {
- type: 'boolean',
- },
- functions_region: {
- type: 'string',
- },
- git_provider: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- id_domain: {
- type: 'string',
- },
- managed_dns: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- notification_email: {
- type: 'string',
- },
- password: {
- type: 'string',
- },
- plan: {
- type: 'string',
- },
- prerender: {
- type: 'string',
- },
- processing_settings: {
- properties: {
- html: {
- properties: {
- pretty_urls: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- published_deploy: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- screenshot_url: {
- type: 'string',
- },
- session_id: {
- type: 'string',
- },
- ssl: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- {
- properties: {
- repo: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- },
- ],
- },
- },
- },
- path: {
- account_slug: {
- in: 'path',
- name: 'account_slug',
- required: true,
- type: 'string',
- },
- },
- query: {
- configure_dns: {
- in: 'query',
- name: 'configure_dns',
- type: 'boolean',
- },
- },
- },
- path: '/{account_slug}/sites',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- admin_url: {
- type: 'string',
- },
- branch_deploy_custom_domain: {
- type: 'string',
- },
- build_image: {
- type: 'string',
- },
- build_settings: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- capabilities: {
- additionalProperties: {
- type: 'object',
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- custom_domain: {
- type: 'string',
- },
- default_hooks_data: {
- properties: {
- access_token: {
- type: 'string',
- },
- },
- type: 'object',
- },
- deploy_hook: {
- type: 'string',
- },
- deploy_preview_custom_domain: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- domain_aliases: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- force_ssl: {
- type: 'boolean',
- },
- functions_region: {
- type: 'string',
- },
- git_provider: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- id_domain: {
- type: 'string',
- },
- managed_dns: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- notification_email: {
- type: 'string',
- },
- password: {
- type: 'string',
- },
- plan: {
- type: 'string',
- },
- prerender: {
- type: 'string',
- },
- processing_settings: {
- properties: {
- html: {
- properties: {
- pretty_urls: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- published_deploy: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- screenshot_url: {
- type: 'string',
- },
- session_id: {
- type: 'string',
- },
- ssl: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'site',
- ],
- verb: 'post',
- },
- {
- description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables.',
- operationId: 'listSitesForAccount',
- parameters: {
- body: {},
- path: {
- account_slug: {
- in: 'path',
- name: 'account_slug',
- required: true,
- type: 'string',
- },
- },
- query: {
- name: {
- in: 'query',
- name: 'name',
- type: 'string',
- },
- page: {
- format: 'int32',
- in: 'query',
- name: 'page',
- required: false,
- type: 'integer',
- },
- per_page: {
- format: 'int32',
- in: 'query',
- name: 'per_page',
- required: false,
- type: 'integer',
- },
- },
- },
- path: '/{account_slug}/sites',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- admin_url: {
- type: 'string',
- },
- branch_deploy_custom_domain: {
- type: 'string',
- },
- build_image: {
- type: 'string',
- },
- build_settings: {
- properties: {
- allowed_branches: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- cmd: {
- type: 'string',
- },
- deploy_key_id: {
- type: 'string',
- },
- dir: {
- type: 'string',
- },
- env: {
- additionalProperties: {
- type: 'string',
- },
- type: 'object',
- },
- functions_dir: {
- type: 'string',
- },
- id: {
- type: 'integer',
- },
- installation_id: {
- type: 'integer',
- },
- private_logs: {
- type: 'boolean',
- },
- provider: {
- type: 'string',
- },
- public_repo: {
- type: 'boolean',
- },
- repo_branch: {
- type: 'string',
- },
- repo_path: {
- type: 'string',
- },
- repo_url: {
- type: 'string',
- },
- stop_builds: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- capabilities: {
- additionalProperties: {
- type: 'object',
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- custom_domain: {
- type: 'string',
- },
- default_hooks_data: {
- properties: {
- access_token: {
- type: 'string',
- },
- },
- type: 'object',
- },
- deploy_hook: {
- type: 'string',
- },
- deploy_preview_custom_domain: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- domain_aliases: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- force_ssl: {
- type: 'boolean',
- },
- functions_region: {
- type: 'string',
- },
- git_provider: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- id_domain: {
- type: 'string',
- },
- managed_dns: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- notification_email: {
- type: 'string',
- },
- password: {
- type: 'string',
- },
- plan: {
- type: 'string',
- },
- prerender: {
- type: 'string',
- },
- processing_settings: {
- properties: {
- html: {
- properties: {
- pretty_urls: {
- type: 'boolean',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- published_deploy: {
- properties: {
- admin_url: {
- type: 'string',
- },
- branch: {
- type: 'string',
- },
- build_id: {
- type: 'string',
- },
- commit_ref: {
- type: 'string',
- },
- commit_url: {
- type: 'string',
- },
- context: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- deploy_ssl_url: {
- type: 'string',
- },
- deploy_url: {
- type: 'string',
- },
- draft: {
- type: 'boolean',
- },
- error_message: {
- type: 'string',
- },
- framework: {
- type: 'string',
- },
- function_schedules: {
- items: {
- properties: {
- cron: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- locked: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- published_at: {
- format: 'dateTime',
- type: 'string',
- },
- required: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- required_functions: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- review_id: {
- type: 'number',
- },
- review_url: {
- type: 'string',
- },
- screenshot_url: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- skipped: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- screenshot_url: {
- type: 'string',
- },
- session_id: {
- type: 'string',
- },
- ssl: {
- type: 'boolean',
- },
- ssl_url: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'site',
- ],
- verb: 'get',
- },
- {
- operationId: 'listMembersForAccount',
- parameters: {
- body: {},
- path: {
- account_slug: {
- in: 'path',
- name: 'account_slug',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/{account_slug}/members',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- avatar: {
- type: 'string',
- },
- email: {
- type: 'string',
- },
- full_name: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- role: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'member',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'addMemberToAccount',
- parameters: {
- body: {
- accountAddMemberSetup: {
- in: 'body',
- name: 'accountAddMemberSetup',
- required: true,
- schema: {
- properties: {
- email: {
- type: 'string',
- },
- role: {
- enum: [
- 'Owner',
- 'Developer',
- 'Billing Admin',
- 'Reviewer',
- ],
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- account_slug: {
- in: 'path',
- name: 'account_slug',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/{account_slug}/members',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- avatar: {
- type: 'string',
- },
- email: {
- type: 'string',
- },
- full_name: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- role: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'member',
- ],
- verb: 'post',
- },
- {
- operationId: 'getAccountMember',
- parameters: {
- body: {},
- path: {
- account_slug: {
- in: 'path',
- name: 'account_slug',
- required: true,
- type: 'string',
- },
- member_id: {
- in: 'path',
- name: 'member_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/{account_slug}/members/{member_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- avatar: {
- type: 'string',
- },
- email: {
- type: 'string',
- },
- full_name: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- role: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'member',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'updateAccountMember',
- parameters: {
- body: {
- accountUpdateMemberSetup: {
- in: 'body',
- name: 'accountUpdateMemberSetup',
- required: true,
- schema: {
- properties: {
- role: {
- enum: [
- 'Owner',
- 'Developer',
- 'Billing Admin',
- 'Reviewer',
- ],
- type: 'string',
- },
- site_access: {
- enum: [
- 'all',
- 'none',
- 'selected',
- ],
- type: 'string',
- },
- site_ids: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- account_slug: {
- in: 'path',
- name: 'account_slug',
- required: true,
- type: 'string',
- },
- member_id: {
- in: 'path',
- name: 'member_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/{account_slug}/members/{member_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- avatar: {
- type: 'string',
- },
- email: {
- type: 'string',
- },
- full_name: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- role: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'member',
- ],
- verb: 'put',
- },
- {
- operationId: 'removeAccountMember',
- parameters: {
- body: {},
- path: {
- account_slug: {
- in: 'path',
- name: 'account_slug',
- required: true,
- type: 'string',
- },
- member_id: {
- in: 'path',
- name: 'member_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/{account_slug}/members/{member_id}',
- responses: {
- 204: {
- description: 'Not Content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'member',
- ],
- verb: 'delete',
- },
- {
- operationId: 'listPaymentMethodsForUser',
- parameters: {
- body: {},
- path: {},
- query: {},
- },
- path: '/billing/payment_methods',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- properties: {
- card_type: {
- type: 'string',
- },
- email: {
- type: 'string',
- },
- last4: {
- type: 'string',
- },
- },
- type: 'object',
- },
- id: {
- type: 'string',
- },
- method_name: {
- type: 'string',
- },
- state: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'paymentMethod',
- ],
- verb: 'get',
- },
- {
- operationId: 'listAccountTypesForUser',
- parameters: {
- body: {},
- path: {},
- query: {},
- },
- path: '/accounts/types',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- capabilities: {
- type: 'object',
- },
- description: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- monthly_dollar_price: {
- type: 'integer',
- },
- monthly_seats_addon_dollar_price: {
- type: 'integer',
- },
- name: {
- type: 'string',
- },
- yearly_dollar_price: {
- type: 'integer',
- },
- yearly_seats_addon_dollar_price: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'accountType',
- ],
- verb: 'get',
- },
- {
- operationId: 'listAccountsForUser',
- parameters: {
- body: {},
- path: {},
- query: {},
- },
- path: '/accounts',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- billing_details: {
- type: 'string',
- },
- billing_email: {
- type: 'string',
- },
- billing_name: {
- type: 'string',
- },
- billing_period: {
- type: 'string',
- },
- capabilities: {
- properties: {
- collaborators: {
- properties: {
- included: {
- type: 'integer',
- },
- used: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- sites: {
- properties: {
- included: {
- type: 'integer',
- },
- used: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- owner_ids: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- payment_method_id: {
- type: 'string',
- },
- roles_allowed: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- slug: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- type_id: {
- type: 'string',
- },
- type_name: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'accountMembership',
- ],
- verb: 'get',
- },
- {
- operationId: 'createAccount',
- parameters: {
- body: {
- accountSetup: {
- in: 'body',
- name: 'accountSetup',
- required: true,
- schema: {
- properties: {
- extra_seats_block: {
- type: 'integer',
- },
- name: {
- type: 'string',
- },
- payment_method_id: {
- type: 'string',
- },
- period: {
- enum: [
- 'monthly',
- 'yearly',
- ],
- type: 'string',
- },
- type_id: {
- type: 'string',
- },
- },
- required: [
- 'name',
- 'type_id',
- ],
- type: 'object',
- },
- },
- },
- path: {},
- query: {},
- },
- path: '/accounts',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- billing_details: {
- type: 'string',
- },
- billing_email: {
- type: 'string',
- },
- billing_name: {
- type: 'string',
- },
- billing_period: {
- type: 'string',
- },
- capabilities: {
- properties: {
- collaborators: {
- properties: {
- included: {
- type: 'integer',
- },
- used: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- sites: {
- properties: {
- included: {
- type: 'integer',
- },
- used: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- owner_ids: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- payment_method_id: {
- type: 'string',
- },
- roles_allowed: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- slug: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- type_id: {
- type: 'string',
- },
- type_name: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'accountMembership',
- ],
- verb: 'post',
- },
- {
- operationId: 'getAccount',
- parameters: {
- body: {},
- path: {
- account_id: {
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/accounts/{account_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- billing_details: {
- type: 'string',
- },
- billing_email: {
- type: 'string',
- },
- billing_name: {
- type: 'string',
- },
- billing_period: {
- type: 'string',
- },
- capabilities: {
- properties: {
- collaborators: {
- properties: {
- included: {
- type: 'integer',
- },
- used: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- sites: {
- properties: {
- included: {
- type: 'integer',
- },
- used: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- owner_ids: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- payment_method_id: {
- type: 'string',
- },
- roles_allowed: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- slug: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- type_id: {
- type: 'string',
- },
- type_name: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'accountMembership',
- ],
- verb: 'get',
- },
- {
- operationId: 'updateAccount',
- parameters: {
- body: {
- accountUpdateSetup: {
- in: 'body',
- name: 'accountUpdateSetup',
- schema: {
- properties: {
- billing_details: {
- type: 'string',
- },
- billing_email: {
- type: 'string',
- },
- billing_name: {
- type: 'string',
- },
- extra_seats_block: {
- type: 'integer',
- },
- name: {
- type: 'string',
- },
- slug: {
- type: 'string',
- },
- type_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- account_id: {
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/accounts/{account_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- billing_details: {
- type: 'string',
- },
- billing_email: {
- type: 'string',
- },
- billing_name: {
- type: 'string',
- },
- billing_period: {
- type: 'string',
- },
- capabilities: {
- properties: {
- collaborators: {
- properties: {
- included: {
- type: 'integer',
- },
- used: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- sites: {
- properties: {
- included: {
- type: 'integer',
- },
- used: {
- type: 'integer',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- owner_ids: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- payment_method_id: {
- type: 'string',
- },
- roles_allowed: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- slug: {
- type: 'string',
- },
- type: {
- type: 'string',
- },
- type_id: {
- type: 'string',
- },
- type_name: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'accountMembership',
- ],
- verb: 'put',
- },
- {
- operationId: 'cancelAccount',
- parameters: {
- body: {},
- path: {
- account_id: {
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/accounts/{account_id}',
- responses: {
- 204: {
- description: 'Not Content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'accountMembership',
- ],
- verb: 'delete',
- },
- {
- operationId: 'listAccountAuditEvents',
- parameters: {
- body: {},
- path: {
- account_id: {
- in: 'path',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- log_type: {
- in: 'query',
- name: 'log_type',
- type: 'string',
- },
- page: {
- format: 'int32',
- in: 'query',
- name: 'page',
- required: false,
- type: 'integer',
- },
- per_page: {
- format: 'int32',
- in: 'query',
- name: 'per_page',
- required: false,
- type: 'integer',
- },
- query: {
- in: 'query',
- name: 'query',
- type: 'string',
- },
- },
- },
- path: '/accounts/{account_id}/audit',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- account_id: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- payload: {
- additionalProperties: {
- type: 'object',
- },
- properties: {
- action: {
- type: 'string',
- },
- actor_email: {
- type: 'string',
- },
- actor_id: {
- type: 'string',
- },
- actor_name: {
- type: 'string',
- },
- log_type: {
- type: 'string',
- },
- timestamp: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'auditLog',
- ],
- verb: 'get',
- },
- {
- operationId: 'listFormSubmission',
- parameters: {
- body: {},
- path: {
- submission_id: {
- in: 'path',
- name: 'submission_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- page: {
- format: 'int32',
- in: 'query',
- name: 'page',
- required: false,
- type: 'integer',
- },
- per_page: {
- format: 'int32',
- in: 'query',
- name: 'per_page',
- required: false,
- type: 'integer',
- },
- query: {
- in: 'query',
- name: 'query',
- type: 'string',
- },
- },
- },
- path: '/submissions/{submission_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- body: {
- type: 'string',
- },
- company: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- data: {
- type: 'object',
- },
- email: {
- type: 'string',
- },
- first_name: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- last_name: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- number: {
- format: 'int32',
- type: 'integer',
- },
- site_url: {
- type: 'string',
- },
- summary: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'submission',
- ],
- verb: 'get',
- },
- {
- operationId: 'deleteSubmission',
- parameters: {
- body: {},
- path: {
- submission_id: {
- in: 'path',
- name: 'submission_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/submissions/{submission_id}',
- responses: {
- 204: {
- description: 'Deleted',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'submission',
- ],
- verb: 'delete',
- },
- {
- operationId: 'listServiceInstancesForSite',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/service-instances',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- auth_url: {
- type: 'string',
- },
- config: {
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- env: {
- type: 'object',
- },
- external_attributes: {
- type: 'object',
- },
- id: {
- type: 'string',
- },
- service_name: {
- type: 'string',
- },
- service_path: {
- type: 'string',
- },
- service_slug: {
- type: 'string',
- },
- snippets: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'serviceInstance',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'createServiceInstance',
- parameters: {
- body: {
- config: {
- in: 'body',
- name: 'config',
- required: true,
- schema: {
- type: 'object',
- },
- },
- },
- path: {
- addon: {
- in: 'path',
- name: 'addon',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/services/{addon}/instances',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- auth_url: {
- type: 'string',
- },
- config: {
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- env: {
- type: 'object',
- },
- external_attributes: {
- type: 'object',
- },
- id: {
- type: 'string',
- },
- service_name: {
- type: 'string',
- },
- service_path: {
- type: 'string',
- },
- service_slug: {
- type: 'string',
- },
- snippets: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'serviceInstance',
- ],
- verb: 'post',
- },
- {
- operationId: 'showServiceInstance',
- parameters: {
- body: {},
- path: {
- addon: {
- in: 'path',
- name: 'addon',
- required: true,
- type: 'string',
- },
- instance_id: {
- in: 'path',
- name: 'instance_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/services/{addon}/instances/{instance_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- auth_url: {
- type: 'string',
- },
- config: {
- type: 'object',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- env: {
- type: 'object',
- },
- external_attributes: {
- type: 'object',
- },
- id: {
- type: 'string',
- },
- service_name: {
- type: 'string',
- },
- service_path: {
- type: 'string',
- },
- service_slug: {
- type: 'string',
- },
- snippets: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'serviceInstance',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'updateServiceInstance',
- parameters: {
- body: {
- config: {
- in: 'body',
- name: 'config',
- required: true,
- schema: {
- type: 'object',
- },
- },
- },
- path: {
- addon: {
- in: 'path',
- name: 'addon',
- required: true,
- type: 'string',
- },
- instance_id: {
- in: 'path',
- name: 'instance_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/services/{addon}/instances/{instance_id}',
- responses: {
- 204: {
- description: 'No Content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'serviceInstance',
- ],
- verb: 'put',
- },
- {
- operationId: 'deleteServiceInstance',
- parameters: {
- body: {},
- path: {
- addon: {
- in: 'path',
- name: 'addon',
- required: true,
- type: 'string',
- },
- instance_id: {
- in: 'path',
- name: 'instance_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/services/{addon}/instances/{instance_id}',
- responses: {
- 204: {
- description: 'Deleted',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'serviceInstance',
- ],
- verb: 'delete',
- },
- {
- operationId: 'getServices',
- parameters: {
- body: {},
- path: {},
- query: {
- search: {
- in: 'query',
- name: 'search',
- type: 'string',
- },
- },
- },
- path: '/services/',
- responses: {
- 200: {
- description: 'services',
- schema: {
- items: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- description: {
- type: 'string',
- },
- environments: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- events: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- icon: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- long_description: {
- type: 'string',
- },
- manifest_url: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- service_path: {
- type: 'string',
- },
- slug: {
- type: 'string',
- },
- tags: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'service',
- ],
- verb: 'get',
- },
- {
- operationId: 'showService',
- parameters: {
- body: {},
- path: {
- addonName: {
- in: 'path',
- name: 'addonName',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/services/{addonName}',
- responses: {
- 200: {
- description: 'services',
- schema: {
- properties: {
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- description: {
- type: 'string',
- },
- environments: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- events: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- icon: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- long_description: {
- type: 'string',
- },
- manifest_url: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- service_path: {
- type: 'string',
- },
- slug: {
- type: 'string',
- },
- tags: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'service',
- ],
- verb: 'get',
- },
- {
- operationId: 'showServiceManifest',
- parameters: {
- body: {},
- path: {
- addonName: {
- in: 'path',
- name: 'addonName',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/services/{addonName}/manifest',
- responses: {
- 201: {
- description: 'retrieving from provider',
- schema: {
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'service',
- ],
- verb: 'get',
- },
- {
- operationId: 'getCurrentUser',
- parameters: {
- body: {},
- path: {},
- query: {},
- },
- path: '/user',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- affiliate_id: {
- type: 'string',
- },
- avatar_url: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- email: {
- type: 'string',
- },
- full_name: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- last_login: {
- format: 'dateTime',
- type: 'string',
- },
- login_providers: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- onboarding_progress: {
- properties: {
- slides: {
- type: 'string',
- },
- },
- type: 'object',
- },
- site_count: {
- format: 'int64',
- type: 'integer',
- },
- uid: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'user',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'createSplitTest',
- parameters: {
- body: {
- branch_tests: {
- in: 'body',
- name: 'branch_tests',
- required: true,
- schema: {
- properties: {
- branch_tests: {
- type: 'object',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/traffic_splits',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- active: {
- type: 'boolean',
- },
- branches: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- path: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- unpublished_at: {
- format: 'dateTime',
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'splitTest',
- ],
- verb: 'post',
- },
- {
- operationId: 'getSplitTests',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/traffic_splits',
- responses: {
- 200: {
- description: 'split_tests',
- schema: {
- items: {
- properties: {
- active: {
- type: 'boolean',
- },
- branches: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- path: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- unpublished_at: {
- format: 'dateTime',
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'splitTest',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'updateSplitTest',
- parameters: {
- body: {
- branch_tests: {
- in: 'body',
- name: 'branch_tests',
- required: true,
- schema: {
- properties: {
- branch_tests: {
- type: 'object',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- split_test_id: {
- in: 'path',
- name: 'split_test_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/traffic_splits/{split_test_id}',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- active: {
- type: 'boolean',
- },
- branches: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- path: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- unpublished_at: {
- format: 'dateTime',
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'splitTest',
- ],
- verb: 'put',
- },
- {
- operationId: 'getSplitTest',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- split_test_id: {
- in: 'path',
- name: 'split_test_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/traffic_splits/{split_test_id}',
- responses: {
- 200: {
- description: 'split_test',
- schema: {
- properties: {
- active: {
- type: 'boolean',
- },
- branches: {
- items: {
- type: 'object',
- },
- type: 'array',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- path: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- unpublished_at: {
- format: 'dateTime',
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'splitTest',
- ],
- verb: 'get',
- },
- {
- operationId: 'enableSplitTest',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- split_test_id: {
- in: 'path',
- name: 'split_test_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/traffic_splits/{split_test_id}/publish',
- responses: {
- 204: {
- description: 'enable',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'splitTest',
- ],
- verb: 'post',
- },
- {
- operationId: 'disableSplitTest',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- split_test_id: {
- in: 'path',
- name: 'split_test_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/traffic_splits/{split_test_id}/unpublish',
- responses: {
- 204: {
- description: 'disabled',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'splitTest',
- ],
- verb: 'post',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'createDnsZone',
- parameters: {
- body: {
- DnsZoneParams: {
- in: 'body',
- name: 'DnsZoneParams',
- required: true,
- schema: {
- properties: {
- account_slug: {
- type: 'string',
- },
- name: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {},
- query: {},
- },
- path: '/dns_zones',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- account_id: {
- type: 'string',
- },
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- dedicated: {
- type: 'boolean',
- },
- dns_servers: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- domain: {
- type: 'string',
- },
- errors: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- ipv6_enabled: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- records: {
- items: {
- properties: {
- dns_zone_id: {
- type: 'string',
- },
- flag: {
- type: 'integer',
- },
- hostname: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- managed: {
- type: 'boolean',
- },
- priority: {
- format: 'int64',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- tag: {
- type: 'string',
- },
- ttl: {
- format: 'int64',
- type: 'integer',
- },
- type: {
- type: 'string',
- },
- value: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- site_id: {
- type: 'string',
- },
- supported_record_types: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'post',
- },
- {
- operationId: 'getDnsZones',
- parameters: {
- body: {},
- path: {},
- query: {
- account_slug: {
- in: 'query',
- name: 'account_slug',
- required: false,
- type: 'string',
- },
- },
- },
- path: '/dns_zones',
- responses: {
- 200: {
- description: 'get all DNS zones the user has access to',
- schema: {
- items: {
- properties: {
- account_id: {
- type: 'string',
- },
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- dedicated: {
- type: 'boolean',
- },
- dns_servers: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- domain: {
- type: 'string',
- },
- errors: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- ipv6_enabled: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- records: {
- items: {
- properties: {
- dns_zone_id: {
- type: 'string',
- },
- flag: {
- type: 'integer',
- },
- hostname: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- managed: {
- type: 'boolean',
- },
- priority: {
- format: 'int64',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- tag: {
- type: 'string',
- },
- ttl: {
- format: 'int64',
- type: 'integer',
- },
- type: {
- type: 'string',
- },
- value: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- site_id: {
- type: 'string',
- },
- supported_record_types: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'get',
- },
- {
- operationId: 'getDnsZone',
- parameters: {
- body: {},
- path: {
- zone_id: {
- in: 'path',
- name: 'zone_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/dns_zones/{zone_id}',
- responses: {
- 200: {
- description: 'get a single DNS zone',
- schema: {
- properties: {
- account_id: {
- type: 'string',
- },
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- dedicated: {
- type: 'boolean',
- },
- dns_servers: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- domain: {
- type: 'string',
- },
- errors: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- ipv6_enabled: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- records: {
- items: {
- properties: {
- dns_zone_id: {
- type: 'string',
- },
- flag: {
- type: 'integer',
- },
- hostname: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- managed: {
- type: 'boolean',
- },
- priority: {
- format: 'int64',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- tag: {
- type: 'string',
- },
- ttl: {
- format: 'int64',
- type: 'integer',
- },
- type: {
- type: 'string',
- },
- value: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- site_id: {
- type: 'string',
- },
- supported_record_types: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'get',
- },
- {
- operationId: 'deleteDnsZone',
- parameters: {
- body: {},
- path: {
- zone_id: {
- in: 'path',
- name: 'zone_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/dns_zones/{zone_id}',
- responses: {
- 204: {
- description: 'delete a single DNS zone',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'delete',
- },
- {
- operationId: 'transferDnsZone',
- parameters: {
- body: {},
- path: {
- zone_id: {
- in: 'path',
- name: 'zone_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- account_id: {
- description: 'the account of the dns zone',
- in: 'query',
- name: 'account_id',
- required: true,
- type: 'string',
- },
- transfer_account_id: {
- description: 'the account you want to transfer the dns zone to',
- in: 'query',
- name: 'transfer_account_id',
- required: true,
- type: 'string',
- },
- transfer_user_id: {
- description: 'the user you want to transfer the dns zone to',
- in: 'query',
- name: 'transfer_user_id',
- required: true,
- type: 'string',
- },
- },
- },
- path: '/dns_zones/{zone_id}/transfer',
- responses: {
- 200: {
- description: 'transfer a DNS zone to another account',
- schema: {
- properties: {
- account_id: {
- type: 'string',
- },
- account_name: {
- type: 'string',
- },
- account_slug: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- dedicated: {
- type: 'boolean',
- },
- dns_servers: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- domain: {
- type: 'string',
- },
- errors: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- id: {
- type: 'string',
- },
- ipv6_enabled: {
- type: 'boolean',
- },
- name: {
- type: 'string',
- },
- records: {
- items: {
- properties: {
- dns_zone_id: {
- type: 'string',
- },
- flag: {
- type: 'integer',
- },
- hostname: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- managed: {
- type: 'boolean',
- },
- priority: {
- format: 'int64',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- tag: {
- type: 'string',
- },
- ttl: {
- format: 'int64',
- type: 'integer',
- },
- type: {
- type: 'string',
- },
- value: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- site_id: {
- type: 'string',
- },
- supported_record_types: {
- items: {
- type: 'string',
- },
- type: 'array',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- user_id: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'put',
- },
- {
- operationId: 'getDnsRecords',
- parameters: {
- body: {},
- path: {
- zone_id: {
- in: 'path',
- name: 'zone_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/dns_zones/{zone_id}/dns_records',
- responses: {
- 200: {
- description: 'get all DNS records for a single DNS zone',
- schema: {
- items: {
- properties: {
- dns_zone_id: {
- type: 'string',
- },
- flag: {
- type: 'integer',
- },
- hostname: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- managed: {
- type: 'boolean',
- },
- priority: {
- format: 'int64',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- tag: {
- type: 'string',
- },
- ttl: {
- format: 'int64',
- type: 'integer',
- },
- type: {
- type: 'string',
- },
- value: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'createDnsRecord',
- parameters: {
- body: {
- dns_record: {
- in: 'body',
- name: 'dns_record',
- required: true,
- schema: {
- properties: {
- flag: {
- format: 'int64',
- type: 'integer',
- },
- hostname: {
- type: 'string',
- },
- port: {
- format: 'int64',
- type: 'integer',
- },
- priority: {
- format: 'int64',
- type: 'integer',
- },
- tag: {
- type: 'string',
- },
- ttl: {
- format: 'int64',
- type: 'integer',
- },
- type: {
- type: 'string',
- },
- value: {
- type: 'string',
- },
- weight: {
- format: 'int64',
- type: 'integer',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- zone_id: {
- in: 'path',
- name: 'zone_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/dns_zones/{zone_id}/dns_records',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- dns_zone_id: {
- type: 'string',
- },
- flag: {
- type: 'integer',
- },
- hostname: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- managed: {
- type: 'boolean',
- },
- priority: {
- format: 'int64',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- tag: {
- type: 'string',
- },
- ttl: {
- format: 'int64',
- type: 'integer',
- },
- type: {
- type: 'string',
- },
- value: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'post',
- },
- {
- operationId: 'getIndividualDnsRecord',
- parameters: {
- body: {},
- path: {
- dns_record_id: {
- in: 'path',
- name: 'dns_record_id',
- required: true,
- type: 'string',
- },
- zone_id: {
- in: 'path',
- name: 'zone_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/dns_zones/{zone_id}/dns_records/{dns_record_id}',
- responses: {
- 200: {
- description: 'get a single DNS record',
- schema: {
- properties: {
- dns_zone_id: {
- type: 'string',
- },
- flag: {
- type: 'integer',
- },
- hostname: {
- type: 'string',
- },
- id: {
- type: 'string',
- },
- managed: {
- type: 'boolean',
- },
- priority: {
- format: 'int64',
- type: 'integer',
- },
- site_id: {
- type: 'string',
- },
- tag: {
- type: 'string',
- },
- ttl: {
- format: 'int64',
- type: 'integer',
- },
- type: {
- type: 'string',
- },
- value: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'get',
- },
- {
- operationId: 'deleteDnsRecord',
- parameters: {
- body: {},
- path: {
- dns_record_id: {
- in: 'path',
- name: 'dns_record_id',
- required: true,
- type: 'string',
- },
- zone_id: {
- in: 'path',
- name: 'zone_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/dns_zones/{zone_id}/dns_records/{dns_record_id}',
- responses: {
- 204: {
- description: 'record deleted',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'dnsZone',
- ],
- verb: 'delete',
- },
- {
- operationId: 'listSiteDevServers',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- page: {
- format: 'int32',
- in: 'query',
- name: 'page',
- required: false,
- type: 'integer',
- },
- per_page: {
- format: 'int32',
- in: 'query',
- name: 'per_page',
- required: false,
- type: 'integer',
- },
- },
- },
- path: '/sites/{site_id}/dev_servers',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- branch: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- done_at: {
- format: 'dateTime',
- type: 'string',
- },
- error_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- live_at: {
- format: 'dateTime',
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- starting_at: {
- format: 'dateTime',
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'devServer',
- ],
- verb: 'get',
- },
- {
- operationId: 'createSiteDevServer',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- branch: {
- in: 'query',
- name: 'branch',
- type: 'string',
- },
- },
- },
- path: '/sites/{site_id}/dev_servers',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- branch: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- done_at: {
- format: 'dateTime',
- type: 'string',
- },
- error_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- live_at: {
- format: 'dateTime',
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- starting_at: {
- format: 'dateTime',
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'devServer',
- ],
- verb: 'post',
- },
- {
- operationId: 'deleteSiteDevServers',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {
- branch: {
- in: 'query',
- name: 'branch',
- type: 'string',
- },
- },
- },
- path: '/sites/{site_id}/dev_servers',
- responses: {
- 202: {
- description: 'OK',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'devServer',
- ],
- verb: 'delete',
- },
- {
- operationId: 'getSiteDevServer',
- parameters: {
- body: {},
- path: {
- dev_server_id: {
- in: 'path',
- name: 'dev_server_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/dev_servers/{dev_server_id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- branch: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- done_at: {
- format: 'dateTime',
- type: 'string',
- },
- error_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- live_at: {
- format: 'dateTime',
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- starting_at: {
- format: 'dateTime',
- type: 'string',
- },
- state: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- updated_at: {
- format: 'dateTime',
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- tags: [
- 'devServer',
- ],
- verb: 'get',
- },
- {
- operationId: 'markDevServerActivity',
- parameters: {
- body: {},
- path: {
- dev_server_id: {
- in: 'path',
- name: 'dev_server_id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/dev_servers/{dev_server_id}/activity',
- responses: {
- 200: {
- description: 'OK',
- },
- },
- tags: [
- 'devServer',
- ],
- verb: 'post',
- 'x-internal': true,
- },
- {
- operationId: 'listSiteDevServerHooks',
- parameters: {
- body: {},
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/dev_server_hooks',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- items: {
- properties: {
- branch: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- type: {
- enum: [
- 'new_dev_server',
- 'content_refresh',
- ],
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- type: 'array',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'devServerHook',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'createSiteDevServerHook',
- parameters: {
- body: {
- devServerHook: {
- in: 'body',
- name: 'devServerHook',
- required: true,
- schema: {
- properties: {
- branch: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- type: {
- enum: [
- 'new_dev_server',
- 'content_refresh',
- ],
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/dev_server_hooks',
- responses: {
- 201: {
- description: 'Created',
- schema: {
- properties: {
- branch: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- type: {
- enum: [
- 'new_dev_server',
- 'content_refresh',
- ],
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'devServerHook',
- ],
- verb: 'post',
- },
- {
- operationId: 'getSiteDevServerHook',
- parameters: {
- body: {},
- path: {
- id: {
- in: 'path',
- name: 'id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/dev_server_hooks/{id}',
- responses: {
- 200: {
- description: 'OK',
- schema: {
- properties: {
- branch: {
- type: 'string',
- },
- created_at: {
- format: 'dateTime',
- type: 'string',
- },
- id: {
- type: 'string',
- },
- site_id: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- type: {
- enum: [
- 'new_dev_server',
- 'content_refresh',
- ],
- type: 'string',
- },
- url: {
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'devServerHook',
- ],
- verb: 'get',
- },
- {
- consumes: [
- 'application/json',
- ],
- operationId: 'updateSiteDevServerHook',
- parameters: {
- body: {
- devServerHook: {
- in: 'body',
- name: 'devServerHook',
- required: true,
- schema: {
- properties: {
- branch: {
- type: 'string',
- },
- title: {
- type: 'string',
- },
- type: {
- enum: [
- 'new_dev_server',
- 'content_refresh',
- ],
- type: 'string',
- },
- },
- type: 'object',
- },
- },
- },
- path: {
- id: {
- in: 'path',
- name: 'id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/dev_server_hooks/{id}',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'devServerHook',
- ],
- verb: 'put',
- },
- {
- operationId: 'deleteSiteDevServerHook',
- parameters: {
- body: {},
- path: {
- id: {
- in: 'path',
- name: 'id',
- required: true,
- type: 'string',
- },
- site_id: {
- in: 'path',
- name: 'site_id',
- required: true,
- type: 'string',
- },
- },
- query: {},
- },
- path: '/sites/{site_id}/dev_server_hooks/{id}',
- responses: {
- 204: {
- description: 'No content',
- },
- default: {
- description: 'error',
- schema: {
- properties: {
- code: {
- format: 'int64',
- type: 'integer',
- },
- message: {
- type: 'string',
- 'x-nullable': false,
- },
- },
- required: [
- 'message',
- ],
- type: 'object',
- },
- },
- },
- tags: [
- 'devServerHook',
- ],
- verb: 'delete',
- },
- ]
diff --git a/packages/js-client/src/operations.test.ts.snap b/packages/js-client/src/operations.test.ts.snap
deleted file mode 100644
index b9cef4b13a..0000000000
Binary files a/packages/js-client/src/operations.test.ts.snap and /dev/null differ