Elgato_dark/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite synced 2026-05-23 00:49:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update specs

Browse source
This commit is contained in:
Matej Bačo 2025-02-04 12:34:07 +01:00
parent d30af2c561
commit 7019cea5fa
4 changed files with 1878 additions and 112 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

496
app/config/specs/open-api3-latest-console.json
View file

@ -9956,6 +9956,88 @@
}
},
"\/functions\/{functionId}\/deployments": {
"get": {
"summary": "List deployments",
"operationId": "functionsListDeployments",
"tags": [
"functions"
],
"description": "Get a list of all the function's code deployments. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Deployments List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deploymentList"
}
}
}
}
},
"x-appwrite": {
"method": "listDeployments",
"weight": 295,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "queries",
"description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands, type, size",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
},
{
"name": "search",
"description": "Search term to filter your list results. Max length: 256 chars.",
"required": false,
"schema": {
"type": "string",
"x-example": "<SEARCH>",
"default": ""
},
"in": "query"
}
]
},
"post": {
"summary": "Create deployment",
"operationId": "functionsCreateDeployment",
@ -10050,6 +10132,216 @@
}
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}": {
"get": {
"summary": "Get deployment",
"operationId": "functionsGetDeployment",
"tags": [
"functions"
],
"description": "Get a code deployment by its unique ID.",
"responses": {
"200": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"x-appwrite": {
"method": "getDeployment",
"weight": 296,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete deployment",
"operationId": "functionsDeleteDeployment",
"tags": [
"functions"
],
"description": "Delete a code deployment by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"x-appwrite": {
"method": "deleteDeployment",
"weight": 297,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
]
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}\/build": {
"post": {
"summary": "Rebuild deployment",
"operationId": "functionsCreateBuild",
"tags": [
"functions"
],
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"responses": {
"204": {
"description": "No content"
}
},
"x-appwrite": {
"method": "createBuild",
"weight": 298,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-build.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"buildId": {
"type": "string",
"description": "Build unique ID.",
"x-example": "<BUILD_ID>"
}
}
}
}
}
}
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}\/download": {
"get": {
"summary": "Download deployment",
@ -10529,6 +10821,154 @@
]
}
},
"\/functions\/{functionId}\/variables": {
"get": {
"summary": "List variables",
"operationId": "functionsListVariables",
"tags": [
"functions"
],
"description": "Get a list of all variables of a specific function.",
"responses": {
"200": {
"description": "Variables List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variableList"
}
}
}
}
},
"x-appwrite": {
"method": "listVariables",
"weight": 305,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
]
},
"post": {
"summary": "Create variable",
"operationId": "functionsCreateVariable",
"tags": [
"functions"
],
"description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"responses": {
"201": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"x-appwrite": {
"method": "createVariable",
"weight": 304,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Variable key. Max length: 255 chars.",
"x-example": "<KEY>"
},
"value": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"x-example": "<VALUE>"
},
"secret": {
"type": "boolean",
"description": "Is secret? Secret variables can only be updated or deleted, they cannot be read.",
"x-example": false
}
},
"required": [
"key",
"value"
]
}
}
}
}
}
},
"\/graphql": {
"post": {
"summary": "GraphQL endpoint",
@ -23256,11 +23696,11 @@
"\/sites\/{siteId}\/deployments": {
"get": {
"summary": "List deployments",
"operationId": "functionsListDeployments",
"operationId": "sitesListDeployments",
"tags": [
"functions"
"sites"
],
"description": "Get a list of all the project's code deployments. You can use the query params to filter your results.",
"description": "Get a list of all the site's code deployments. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Deployments List",
@ -23279,8 +23719,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md",
"demo": "sites\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/list-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -23340,9 +23780,9 @@
"\/sites\/{siteId}\/deployments\/{deploymentId}": {
"get": {
"summary": "Get deployment",
"operationId": "functionsGetDeployment",
"operationId": "sitesGetDeployment",
"tags": [
"functions"
"sites"
],
"description": "Get a code deployment by its unique ID.",
"responses": {
@ -23363,8 +23803,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md",
"demo": "sites\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/get-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -23476,9 +23916,9 @@
},
"delete": {
"summary": "Delete deployment",
"operationId": "functionsDeleteDeployment",
"operationId": "sitesDeleteDeployment",
"tags": [
"functions"
"sites"
],
"description": "Delete a code deployment by its unique ID.",
"responses": {
@ -23492,8 +23932,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md",
"demo": "sites\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/delete-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -23539,11 +23979,11 @@
"\/sites\/{siteId}\/deployments\/{deploymentId}\/build": {
"post": {
"summary": "Rebuild deployment",
"operationId": "functionsCreateBuild",
"operationId": "sitesCreateBuild",
"tags": [
"functions"
"sites"
],
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its install command, build command, and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"responses": {
"204": {
"description": "No content"
@ -23555,8 +23995,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-build.md",
"demo": "sites\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/create-build.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -23670,11 +24110,11 @@
"\/sites\/{siteId}\/variables": {
"get": {
"summary": "List variables",
"operationId": "functionsListVariables",
"operationId": "sitesListVariables",
"tags": [
"functions"
"sites"
],
"description": "Get a list of all variables of a specific function.",
"description": "Get a list of all variables of a specific site.",
"responses": {
"200": {
"description": "Variables List",
@ -23693,8 +24133,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md",
"demo": "sites\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -23728,11 +24168,11 @@
},
"post": {
"summary": "Create variable",
"operationId": "functionsCreateVariable",
"operationId": "sitesCreateVariable",
"tags": [
"functions"
"sites"
],
"description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"description": "Create a new site environment variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.",
"responses": {
"201": {
"description": "Variable",
@ -23751,8 +24191,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md",
"demo": "sites\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",

502
app/config/specs/open-api3-latest-server.json
View file

@ -8886,6 +8886,89 @@
}
},
"\/functions\/{functionId}\/deployments": {
"get": {
"summary": "List deployments",
"operationId": "functionsListDeployments",
"tags": [
"functions"
],
"description": "Get a list of all the function's code deployments. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Deployments List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deploymentList"
}
}
}
}
},
"x-appwrite": {
"method": "listDeployments",
"weight": 295,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "queries",
"description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands, type, size",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
},
{
"name": "search",
"description": "Search term to filter your list results. Max length: 256 chars.",
"required": false,
"schema": {
"type": "string",
"x-example": "<SEARCH>",
"default": ""
},
"in": "query"
}
]
},
"post": {
"summary": "Create deployment",
"operationId": "functionsCreateDeployment",
@ -8981,6 +9064,219 @@
}
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}": {
"get": {
"summary": "Get deployment",
"operationId": "functionsGetDeployment",
"tags": [
"functions"
],
"description": "Get a code deployment by its unique ID.",
"responses": {
"200": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"x-appwrite": {
"method": "getDeployment",
"weight": 296,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete deployment",
"operationId": "functionsDeleteDeployment",
"tags": [
"functions"
],
"description": "Delete a code deployment by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"x-appwrite": {
"method": "deleteDeployment",
"weight": 297,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
]
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}\/build": {
"post": {
"summary": "Rebuild deployment",
"operationId": "functionsCreateBuild",
"tags": [
"functions"
],
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"responses": {
"204": {
"description": "No content"
}
},
"x-appwrite": {
"method": "createBuild",
"weight": 298,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-build.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"buildId": {
"type": "string",
"description": "Build unique ID.",
"x-example": "<BUILD_ID>"
}
}
}
}
}
}
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}\/download": {
"get": {
"summary": "Download deployment",
@ -9387,6 +9683,156 @@
]
}
},
"\/functions\/{functionId}\/variables": {
"get": {
"summary": "List variables",
"operationId": "functionsListVariables",
"tags": [
"functions"
],
"description": "Get a list of all variables of a specific function.",
"responses": {
"200": {
"description": "Variables List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variableList"
}
}
}
}
},
"x-appwrite": {
"method": "listVariables",
"weight": 305,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
]
},
"post": {
"summary": "Create variable",
"operationId": "functionsCreateVariable",
"tags": [
"functions"
],
"description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"responses": {
"201": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"x-appwrite": {
"method": "createVariable",
"weight": 304,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Variable key. Max length: 255 chars.",
"x-example": "<KEY>"
},
"value": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"x-example": "<VALUE>"
},
"secret": {
"type": "boolean",
"description": "Is secret? Secret variables can only be updated or deleted, they cannot be read.",
"x-example": false
}
},
"required": [
"key",
"value"
]
}
}
}
}
}
},
"\/graphql": {
"post": {
"summary": "GraphQL endpoint",
@ -15639,11 +16085,11 @@
"\/sites\/{siteId}\/deployments": {
"get": {
"summary": "List deployments",
"operationId": "functionsListDeployments",
"operationId": "sitesListDeployments",
"tags": [
"functions"
"sites"
],
"description": "Get a list of all the project's code deployments. You can use the query params to filter your results.",
"description": "Get a list of all the site's code deployments. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Deployments List",
@ -15662,8 +16108,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md",
"demo": "sites\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/list-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -15724,9 +16170,9 @@
"\/sites\/{siteId}\/deployments\/{deploymentId}": {
"get": {
"summary": "Get deployment",
"operationId": "functionsGetDeployment",
"operationId": "sitesGetDeployment",
"tags": [
"functions"
"sites"
],
"description": "Get a code deployment by its unique ID.",
"responses": {
@ -15747,8 +16193,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md",
"demo": "sites\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/get-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -15862,9 +16308,9 @@
},
"delete": {
"summary": "Delete deployment",
"operationId": "functionsDeleteDeployment",
"operationId": "sitesDeleteDeployment",
"tags": [
"functions"
"sites"
],
"description": "Delete a code deployment by its unique ID.",
"responses": {
@ -15878,8 +16324,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md",
"demo": "sites\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/delete-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -15926,11 +16372,11 @@
"\/sites\/{siteId}\/deployments\/{deploymentId}\/build": {
"post": {
"summary": "Rebuild deployment",
"operationId": "functionsCreateBuild",
"operationId": "sitesCreateBuild",
"tags": [
"functions"
"sites"
],
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its install command, build command, and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"responses": {
"204": {
"description": "No content"
@ -15942,8 +16388,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-build.md",
"demo": "sites\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/create-build.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -16059,11 +16505,11 @@
"\/sites\/{siteId}\/variables": {
"get": {
"summary": "List variables",
"operationId": "functionsListVariables",
"operationId": "sitesListVariables",
"tags": [
"functions"
"sites"
],
"description": "Get a list of all variables of a specific function.",
"description": "Get a list of all variables of a specific site.",
"responses": {
"200": {
"description": "Variables List",
@ -16082,8 +16528,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md",
"demo": "sites\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -16118,11 +16564,11 @@
},
"post": {
"summary": "Create variable",
"operationId": "functionsCreateVariable",
"operationId": "sitesCreateVariable",
"tags": [
"functions"
"sites"
],
"description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"description": "Create a new site environment variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.",
"responses": {
"201": {
"description": "Variable",
@ -16141,8 +16587,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md",
"demo": "sites\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",

493
app/config/specs/swagger2-latest-console.json
View file

@ -10143,6 +10143,85 @@
}
},
"\/functions\/{functionId}\/deployments": {
"get": {
"summary": "List deployments",
"operationId": "functionsListDeployments",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"functions"
],
"description": "Get a list of all the function's code deployments. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Deployments List",
"schema": {
"$ref": "#\/definitions\/deploymentList"
}
}
},
"x-appwrite": {
"method": "listDeployments",
"weight": 295,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
},
{
"name": "queries",
"description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands, type, size",
"required": false,
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "string"
},
"default": [],
"in": "query"
},
{
"name": "search",
"description": "Search term to filter your list results. Max length: 256 chars.",
"required": false,
"type": "string",
"x-example": "<SEARCH>",
"default": "",
"in": "query"
}
]
},
"post": {
"summary": "Create deployment",
"operationId": "functionsCreateDeployment",
@ -10233,6 +10312,215 @@
]
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}": {
"get": {
"summary": "Get deployment",
"operationId": "functionsGetDeployment",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"functions"
],
"description": "Get a code deployment by its unique ID.",
"responses": {
"200": {
"description": "Deployment",
"schema": {
"$ref": "#\/definitions\/deployment"
}
}
},
"x-appwrite": {
"method": "getDeployment",
"weight": 296,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"type": "string",
"x-example": "<DEPLOYMENT_ID>",
"in": "path"
}
]
},
"delete": {
"summary": "Delete deployment",
"operationId": "functionsDeleteDeployment",
"consumes": [
"application\/json"
],
"produces": [],
"tags": [
"functions"
],
"description": "Delete a code deployment by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"x-appwrite": {
"method": "deleteDeployment",
"weight": 297,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"type": "string",
"x-example": "<DEPLOYMENT_ID>",
"in": "path"
}
]
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}\/build": {
"post": {
"summary": "Rebuild deployment",
"operationId": "functionsCreateBuild",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"functions"
],
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"responses": {
"204": {
"description": "No content"
}
},
"x-appwrite": {
"method": "createBuild",
"weight": 298,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-build.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"type": "string",
"x-example": "<DEPLOYMENT_ID>",
"in": "path"
},
{
"name": "payload",
"in": "body",
"schema": {
"type": "object",
"properties": {
"buildId": {
"type": "string",
"description": "Build unique ID.",
"default": "",
"x-example": "<BUILD_ID>"
}
}
}
}
]
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}\/download": {
"get": {
"summary": "Download deployment",
@ -10714,6 +11002,155 @@
]
}
},
"\/functions\/{functionId}\/variables": {
"get": {
"summary": "List variables",
"operationId": "functionsListVariables",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"functions"
],
"description": "Get a list of all variables of a specific function.",
"responses": {
"200": {
"description": "Variables List",
"schema": {
"$ref": "#\/definitions\/variableList"
}
}
},
"x-appwrite": {
"method": "listVariables",
"weight": 305,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
}
]
},
"post": {
"summary": "Create variable",
"operationId": "functionsCreateVariable",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"functions"
],
"description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"responses": {
"201": {
"description": "Variable",
"schema": {
"$ref": "#\/definitions\/variable"
}
}
},
"x-appwrite": {
"method": "createVariable",
"weight": 304,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
},
{
"name": "payload",
"in": "body",
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Variable key. Max length: 255 chars.",
"default": null,
"x-example": "<KEY>"
},
"value": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"default": null,
"x-example": "<VALUE>"
},
"secret": {
"type": "boolean",
"description": "Is secret? Secret variables can only be updated or deleted, they cannot be read.",
"default": false,
"x-example": false
}
},
"required": [
"key",
"value"
]
}
}
]
}
},
"\/graphql": {
"post": {
"summary": "GraphQL endpoint",
@ -23749,7 +24186,7 @@
"\/sites\/{siteId}\/deployments": {
"get": {
"summary": "List deployments",
"operationId": "functionsListDeployments",
"operationId": "sitesListDeployments",
"consumes": [
"application\/json"
],
@ -23757,9 +24194,9 @@
"application\/json"
],
"tags": [
"functions"
"sites"
],
"description": "Get a list of all the project's code deployments. You can use the query params to filter your results.",
"description": "Get a list of all the site's code deployments. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Deployments List",
@ -23774,8 +24211,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md",
"demo": "sites\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/list-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -23830,7 +24267,7 @@
"\/sites\/{siteId}\/deployments\/{deploymentId}": {
"get": {
"summary": "Get deployment",
"operationId": "functionsGetDeployment",
"operationId": "sitesGetDeployment",
"consumes": [
"application\/json"
],
@ -23838,7 +24275,7 @@
"application\/json"
],
"tags": [
"functions"
"sites"
],
"description": "Get a code deployment by its unique ID.",
"responses": {
@ -23855,8 +24292,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md",
"demo": "sites\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/get-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -23962,13 +24399,13 @@
},
"delete": {
"summary": "Delete deployment",
"operationId": "functionsDeleteDeployment",
"operationId": "sitesDeleteDeployment",
"consumes": [
"application\/json"
],
"produces": [],
"tags": [
"functions"
"sites"
],
"description": "Delete a code deployment by its unique ID.",
"responses": {
@ -23982,8 +24419,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md",
"demo": "sites\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/delete-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -24025,7 +24462,7 @@
"\/sites\/{siteId}\/deployments\/{deploymentId}\/build": {
"post": {
"summary": "Rebuild deployment",
"operationId": "functionsCreateBuild",
"operationId": "sitesCreateBuild",
"consumes": [
"application\/json"
],
@ -24033,9 +24470,9 @@
"application\/json"
],
"tags": [
"functions"
"sites"
],
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its install command, build command, and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"responses": {
"204": {
"description": "No content"
@ -24047,8 +24484,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-build.md",
"demo": "sites\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/create-build.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -24156,7 +24593,7 @@
"\/sites\/{siteId}\/variables": {
"get": {
"summary": "List variables",
"operationId": "functionsListVariables",
"operationId": "sitesListVariables",
"consumes": [
"application\/json"
],
@ -24164,9 +24601,9 @@
"application\/json"
],
"tags": [
"functions"
"sites"
],
"description": "Get a list of all variables of a specific function.",
"description": "Get a list of all variables of a specific site.",
"responses": {
"200": {
"description": "Variables List",
@ -24181,8 +24618,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md",
"demo": "sites\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -24214,7 +24651,7 @@
},
"post": {
"summary": "Create variable",
"operationId": "functionsCreateVariable",
"operationId": "sitesCreateVariable",
"consumes": [
"application\/json"
],
@ -24222,9 +24659,9 @@
"application\/json"
],
"tags": [
"functions"
"sites"
],
"description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"description": "Create a new site environment variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.",
"responses": {
"201": {
"description": "Variable",
@ -24239,8 +24676,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md",
"demo": "sites\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",

499
app/config/specs/swagger2-latest-server.json
View file

@ -9074,6 +9074,86 @@
}
},
"\/functions\/{functionId}\/deployments": {
"get": {
"summary": "List deployments",
"operationId": "functionsListDeployments",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"functions"
],
"description": "Get a list of all the function's code deployments. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Deployments List",
"schema": {
"$ref": "#\/definitions\/deploymentList"
}
}
},
"x-appwrite": {
"method": "listDeployments",
"weight": 295,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
},
{
"name": "queries",
"description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands, type, size",
"required": false,
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "string"
},
"default": [],
"in": "query"
},
{
"name": "search",
"description": "Search term to filter your list results. Max length: 256 chars.",
"required": false,
"type": "string",
"x-example": "<SEARCH>",
"default": "",
"in": "query"
}
]
},
"post": {
"summary": "Create deployment",
"operationId": "functionsCreateDeployment",
@ -9165,6 +9245,218 @@
]
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}": {
"get": {
"summary": "Get deployment",
"operationId": "functionsGetDeployment",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"functions"
],
"description": "Get a code deployment by its unique ID.",
"responses": {
"200": {
"description": "Deployment",
"schema": {
"$ref": "#\/definitions\/deployment"
}
}
},
"x-appwrite": {
"method": "getDeployment",
"weight": 296,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"type": "string",
"x-example": "<DEPLOYMENT_ID>",
"in": "path"
}
]
},
"delete": {
"summary": "Delete deployment",
"operationId": "functionsDeleteDeployment",
"consumes": [
"application\/json"
],
"produces": [],
"tags": [
"functions"
],
"description": "Delete a code deployment by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"x-appwrite": {
"method": "deleteDeployment",
"weight": 297,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"type": "string",
"x-example": "<DEPLOYMENT_ID>",
"in": "path"
}
]
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}\/build": {
"post": {
"summary": "Rebuild deployment",
"operationId": "functionsCreateBuild",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"functions"
],
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"responses": {
"204": {
"description": "No content"
}
},
"x-appwrite": {
"method": "createBuild",
"weight": 298,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-build.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"type": "string",
"x-example": "<DEPLOYMENT_ID>",
"in": "path"
},
{
"name": "payload",
"in": "body",
"schema": {
"type": "object",
"properties": {
"buildId": {
"type": "string",
"description": "Build unique ID.",
"default": "",
"x-example": "<BUILD_ID>"
}
}
}
}
]
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}\/download": {
"get": {
"summary": "Download deployment",
@ -9575,6 +9867,157 @@
]
}
},
"\/functions\/{functionId}\/variables": {
"get": {
"summary": "List variables",
"operationId": "functionsListVariables",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"functions"
],
"description": "Get a list of all variables of a specific function.",
"responses": {
"200": {
"description": "Variables List",
"schema": {
"$ref": "#\/definitions\/variableList"
}
}
},
"x-appwrite": {
"method": "listVariables",
"weight": 305,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
}
]
},
"post": {
"summary": "Create variable",
"operationId": "functionsCreateVariable",
"consumes": [
"application\/json"
],
"produces": [
"application\/json"
],
"tags": [
"functions"
],
"description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"responses": {
"201": {
"description": "Variable",
"schema": {
"$ref": "#\/definitions\/variable"
}
}
},
"x-appwrite": {
"method": "createVariable",
"weight": 304,
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"server"
],
"packaging": false,
"auth": {
"Project": [],
"Key": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"type": "string",
"x-example": "<FUNCTION_ID>",
"in": "path"
},
{
"name": "payload",
"in": "body",
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Variable key. Max length: 255 chars.",
"default": null,
"x-example": "<KEY>"
},
"value": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"default": null,
"x-example": "<VALUE>"
},
"secret": {
"type": "boolean",
"description": "Is secret? Secret variables can only be updated or deleted, they cannot be read.",
"default": false,
"x-example": false
}
},
"required": [
"key",
"value"
]
}
}
]
}
},
"\/graphql": {
"post": {
"summary": "GraphQL endpoint",
@ -16112,7 +16555,7 @@
"\/sites\/{siteId}\/deployments": {
"get": {
"summary": "List deployments",
"operationId": "functionsListDeployments",
"operationId": "sitesListDeployments",
"consumes": [
"application\/json"
],
@ -16120,9 +16563,9 @@
"application\/json"
],
"tags": [
"functions"
"sites"
],
"description": "Get a list of all the project's code deployments. You can use the query params to filter your results.",
"description": "Get a list of all the site's code deployments. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Deployments List",
@ -16137,8 +16580,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md",
"demo": "sites\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/list-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -16194,7 +16637,7 @@
"\/sites\/{siteId}\/deployments\/{deploymentId}": {
"get": {
"summary": "Get deployment",
"operationId": "functionsGetDeployment",
"operationId": "sitesGetDeployment",
"consumes": [
"application\/json"
],
@ -16202,7 +16645,7 @@
"application\/json"
],
"tags": [
"functions"
"sites"
],
"description": "Get a code deployment by its unique ID.",
"responses": {
@ -16219,8 +16662,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md",
"demo": "sites\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/get-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -16328,13 +16771,13 @@
},
"delete": {
"summary": "Delete deployment",
"operationId": "functionsDeleteDeployment",
"operationId": "sitesDeleteDeployment",
"consumes": [
"application\/json"
],
"produces": [],
"tags": [
"functions"
"sites"
],
"description": "Delete a code deployment by its unique ID.",
"responses": {
@ -16348,8 +16791,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md",
"demo": "sites\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/delete-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -16392,7 +16835,7 @@
"\/sites\/{siteId}\/deployments\/{deploymentId}\/build": {
"post": {
"summary": "Rebuild deployment",
"operationId": "functionsCreateBuild",
"operationId": "sitesCreateBuild",
"consumes": [
"application\/json"
],
@ -16400,9 +16843,9 @@
"application\/json"
],
"tags": [
"functions"
"sites"
],
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its install command, build command, and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"responses": {
"204": {
"description": "No content"
@ -16414,8 +16857,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-build.md",
"demo": "sites\/create-build.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/create-build.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -16525,7 +16968,7 @@
"\/sites\/{siteId}\/variables": {
"get": {
"summary": "List variables",
"operationId": "functionsListVariables",
"operationId": "sitesListVariables",
"consumes": [
"application\/json"
],
@ -16533,9 +16976,9 @@
"application\/json"
],
"tags": [
"functions"
"sites"
],
"description": "Get a list of all variables of a specific function.",
"description": "Get a list of all variables of a specific site.",
"responses": {
"200": {
"description": "Variables List",
@ -16550,8 +16993,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md",
"demo": "sites\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@ -16584,7 +17027,7 @@
},
"post": {
"summary": "Create variable",
"operationId": "functionsCreateVariable",
"operationId": "sitesCreateVariable",
"consumes": [
"application\/json"
],
@ -16592,9 +17035,9 @@
"application\/json"
],
"tags": [
"functions"
"sites"
],
"description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"description": "Create a new site environment variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.",
"responses": {
"201": {
"description": "Variable",
@ -16609,8 +17052,8 @@
"cookies": false,
"type": "",
"deprecated": false,
"demo": "functions\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md",
"demo": "sites\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/sites\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",