mirror of
https://github.com/appwrite/appwrite.git
synced 2026-05-26 13:51:13 +00:00
Update specs
This commit is contained in:
Matej Bačo
@@ -5033,7 +5033,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "query",
|
||||
"weight": 326,
|
||||
"weight": 324,
|
||||
"cookies": false,
|
||||
"type": "graphql",
|
||||
"deprecated": false,
|
||||
@@ -5084,7 +5084,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "mutation",
|
||||
"weight": 325,
|
||||
"weight": 323,
|
||||
"cookies": false,
|
||||
"type": "graphql",
|
||||
"deprecated": false,
|
||||
@@ -5543,7 +5543,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createSubscriber",
|
||||
"weight": 371,
|
||||
"weight": 369,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -5625,7 +5625,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "deleteSubscriber",
|
||||
"weight": 375,
|
||||
"weight": 373,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -8138,7 +8138,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "list",
|
||||
"weight": 389,
|
||||
"weight": 387,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -8211,7 +8211,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "create",
|
||||
"weight": 387,
|
||||
"weight": 385,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -8402,26 +8402,6 @@
|
||||
"description": "Path to function code in the linked repo.",
|
||||
"x-example": "<PROVIDER_ROOT_DIRECTORY>"
|
||||
},
|
||||
"templateRepository": {
|
||||
"type": "string",
|
||||
"description": "Repository name of the template.",
|
||||
"x-example": "<TEMPLATE_REPOSITORY>"
|
||||
},
|
||||
"templateOwner": {
|
||||
"type": "string",
|
||||
"description": "The name of the owner of the template.",
|
||||
"x-example": "<TEMPLATE_OWNER>"
|
||||
},
|
||||
"templateRootDirectory": {
|
||||
"type": "string",
|
||||
"description": "Path to function code in the template repo.",
|
||||
"x-example": "<TEMPLATE_ROOT_DIRECTORY>"
|
||||
},
|
||||
"templateVersion": {
|
||||
"type": "string",
|
||||
"description": "Version (tag) for the repo linked to the function template.",
|
||||
"x-example": "<TEMPLATE_VERSION>"
|
||||
},
|
||||
"specification": {
|
||||
"type": "string",
|
||||
"description": "Runtime specification for the function and builds.",
|
||||
@@ -8461,7 +8441,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listRuntimes",
|
||||
"weight": 390,
|
||||
"weight": 388,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -8619,7 +8599,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "update",
|
||||
"weight": 388,
|
||||
"weight": 386,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -8990,7 +8970,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createDeployment",
|
||||
"weight": 391,
|
||||
"weight": 389,
|
||||
"cookies": false,
|
||||
"type": "upload",
|
||||
"deprecated": false,
|
||||
@@ -9064,6 +9044,109 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"\/functions\/{functionId}\/deployments\/template": {
|
||||
"post": {
|
||||
"summary": "Create template deployment",
|
||||
"operationId": "functionsCreateTemplateDeployment",
|
||||
"tags": [
|
||||
"functions"
|
||||
],
|
||||
"description": "",
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "Deployment",
|
||||
"content": {
|
||||
"application\/json": {
|
||||
"schema": {
|
||||
"$ref": "#\/components\/schemas\/deployment"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTemplateDeployment",
|
||||
"weight": 390,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "functions\/create-template-deployment.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/server\/functions#listTemplates) to find the template details.",
|
||||
"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"
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application\/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"repository": {
|
||||
"type": "string",
|
||||
"description": "Repository name of the template.",
|
||||
"x-example": "<REPOSITORY>"
|
||||
},
|
||||
"owner": {
|
||||
"type": "string",
|
||||
"description": "The name of the owner of the template.",
|
||||
"x-example": "<OWNER>"
|
||||
},
|
||||
"rootDirectory": {
|
||||
"type": "string",
|
||||
"description": "Path to function code in the template repo.",
|
||||
"x-example": "<ROOT_DIRECTORY>"
|
||||
},
|
||||
"version": {
|
||||
"type": "string",
|
||||
"description": "Version (tag) for the repo linked to the function template.",
|
||||
"x-example": "<VERSION>"
|
||||
},
|
||||
"activate": {
|
||||
"type": "boolean",
|
||||
"description": "Automatically activate the deployment when it is finished building.",
|
||||
"x-example": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"repository",
|
||||
"owner",
|
||||
"rootDirectory",
|
||||
"version"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"\/functions\/{functionId}\/deployments\/{deploymentId}": {
|
||||
"get": {
|
||||
"summary": "Get deployment",
|
||||
@@ -9819,7 +9902,7 @@
|
||||
},
|
||||
"secret": {
|
||||
"type": "boolean",
|
||||
"description": "Is secret? Secret variables can only be updated or deleted, they cannot be read.",
|
||||
"description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.",
|
||||
"x-example": false
|
||||
}
|
||||
},
|
||||
@@ -9855,7 +9938,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "query",
|
||||
"weight": 326,
|
||||
"weight": 324,
|
||||
"cookies": false,
|
||||
"type": "graphql",
|
||||
"deprecated": false,
|
||||
@@ -9908,7 +9991,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "mutation",
|
||||
"weight": 325,
|
||||
"weight": 323,
|
||||
"cookies": false,
|
||||
"type": "graphql",
|
||||
"deprecated": false,
|
||||
@@ -11680,7 +11763,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listMessages",
|
||||
"weight": 379,
|
||||
"weight": 377,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -11756,7 +11839,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createEmail",
|
||||
"weight": 376,
|
||||
"weight": 374,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -11900,7 +11983,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateEmail",
|
||||
"weight": 383,
|
||||
"weight": 381,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12046,7 +12129,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createPush",
|
||||
"weight": 378,
|
||||
"weight": 376,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12220,7 +12303,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updatePush",
|
||||
"weight": 385,
|
||||
"weight": 383,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12398,7 +12481,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createSms",
|
||||
"weight": 377,
|
||||
"weight": 375,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12507,7 +12590,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateSms",
|
||||
"weight": 384,
|
||||
"weight": 382,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12619,7 +12702,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "getMessage",
|
||||
"weight": 382,
|
||||
"weight": 380,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12672,7 +12755,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "delete",
|
||||
"weight": 386,
|
||||
"weight": 384,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12734,7 +12817,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listMessageLogs",
|
||||
"weight": 380,
|
||||
"weight": 378,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12809,7 +12892,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listTargets",
|
||||
"weight": 381,
|
||||
"weight": 379,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12884,7 +12967,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listProviders",
|
||||
"weight": 351,
|
||||
"weight": 349,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12960,7 +13043,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createApnsProvider",
|
||||
"weight": 350,
|
||||
"weight": 348,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13065,7 +13148,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateApnsProvider",
|
||||
"weight": 363,
|
||||
"weight": 361,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13173,7 +13256,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createFcmProvider",
|
||||
"weight": 349,
|
||||
"weight": 347,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13258,7 +13341,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateFcmProvider",
|
||||
"weight": 362,
|
||||
"weight": 360,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13346,7 +13429,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createMailgunProvider",
|
||||
"weight": 341,
|
||||
"weight": 339,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13461,7 +13544,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateMailgunProvider",
|
||||
"weight": 354,
|
||||
"weight": 352,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13579,7 +13662,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createMsg91Provider",
|
||||
"weight": 344,
|
||||
"weight": 342,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13674,7 +13757,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateMsg91Provider",
|
||||
"weight": 357,
|
||||
"weight": 355,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13772,7 +13855,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createSendgridProvider",
|
||||
"weight": 342,
|
||||
"weight": 340,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13877,7 +13960,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateSendgridProvider",
|
||||
"weight": 355,
|
||||
"weight": 353,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13985,7 +14068,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createSmtpProvider",
|
||||
"weight": 343,
|
||||
"weight": 341,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14128,7 +14211,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateSmtpProvider",
|
||||
"weight": 356,
|
||||
"weight": 354,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14273,7 +14356,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTelesignProvider",
|
||||
"weight": 345,
|
||||
"weight": 343,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14368,7 +14451,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateTelesignProvider",
|
||||
"weight": 358,
|
||||
"weight": 356,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14466,7 +14549,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTextmagicProvider",
|
||||
"weight": 346,
|
||||
"weight": 344,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14561,7 +14644,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateTextmagicProvider",
|
||||
"weight": 359,
|
||||
"weight": 357,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14659,7 +14742,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTwilioProvider",
|
||||
"weight": 347,
|
||||
"weight": 345,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14754,7 +14837,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateTwilioProvider",
|
||||
"weight": 360,
|
||||
"weight": 358,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14852,7 +14935,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createVonageProvider",
|
||||
"weight": 348,
|
||||
"weight": 346,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14947,7 +15030,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateVonageProvider",
|
||||
"weight": 361,
|
||||
"weight": 359,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15045,7 +15128,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "getProvider",
|
||||
"weight": 353,
|
||||
"weight": 351,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15098,7 +15181,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "deleteProvider",
|
||||
"weight": 364,
|
||||
"weight": 362,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15160,7 +15243,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listProviderLogs",
|
||||
"weight": 352,
|
||||
"weight": 350,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15235,7 +15318,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listSubscriberLogs",
|
||||
"weight": 373,
|
||||
"weight": 371,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15310,7 +15393,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listTopics",
|
||||
"weight": 366,
|
||||
"weight": 364,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15384,7 +15467,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTopic",
|
||||
"weight": 365,
|
||||
"weight": 363,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15467,7 +15550,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "getTopic",
|
||||
"weight": 368,
|
||||
"weight": 366,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15527,7 +15610,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateTopic",
|
||||
"weight": 369,
|
||||
"weight": 367,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15604,7 +15687,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "deleteTopic",
|
||||
"weight": 370,
|
||||
"weight": 368,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15666,7 +15749,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listTopicLogs",
|
||||
"weight": 367,
|
||||
"weight": 365,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15741,7 +15824,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listSubscribers",
|
||||
"weight": 372,
|
||||
"weight": 370,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15825,7 +15908,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createSubscriber",
|
||||
"weight": 371,
|
||||
"weight": 369,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15916,7 +15999,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "getSubscriber",
|
||||
"weight": 374,
|
||||
"weight": 372,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15979,7 +16062,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "deleteSubscriber",
|
||||
"weight": 375,
|
||||
"weight": 373,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16055,7 +16138,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "list",
|
||||
"weight": 394,
|
||||
"weight": 393,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16125,7 +16208,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "create",
|
||||
"weight": 392,
|
||||
"weight": 391,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16207,11 +16290,6 @@
|
||||
"description": "Output Directory for site.",
|
||||
"x-example": "<OUTPUT_DIRECTORY>"
|
||||
},
|
||||
"subdomain": {
|
||||
"type": "string",
|
||||
"description": "Unique custom sub-domain. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
|
||||
"x-example": "<SUBDOMAIN>"
|
||||
},
|
||||
"buildRuntime": {
|
||||
"type": "string",
|
||||
"description": "Runtime to use during build step.",
|
||||
@@ -16318,26 +16396,6 @@
|
||||
"description": "Path to site code in the linked repo.",
|
||||
"x-example": "<PROVIDER_ROOT_DIRECTORY>"
|
||||
},
|
||||
"templateRepository": {
|
||||
"type": "string",
|
||||
"description": "Repository name of the template.",
|
||||
"x-example": "<TEMPLATE_REPOSITORY>"
|
||||
},
|
||||
"templateOwner": {
|
||||
"type": "string",
|
||||
"description": "The name of the owner of the template.",
|
||||
"x-example": "<TEMPLATE_OWNER>"
|
||||
},
|
||||
"templateRootDirectory": {
|
||||
"type": "string",
|
||||
"description": "Path to site code in the template repo.",
|
||||
"x-example": "<TEMPLATE_ROOT_DIRECTORY>"
|
||||
},
|
||||
"templateVersion": {
|
||||
"type": "string",
|
||||
"description": "Version (tag) for the repo linked to the site template.",
|
||||
"x-example": "<TEMPLATE_VERSION>"
|
||||
},
|
||||
"specification": {
|
||||
"type": "string",
|
||||
"description": "Framework specification for the site and builds.",
|
||||
@@ -16378,7 +16436,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listFrameworks",
|
||||
"weight": 397,
|
||||
"weight": 396,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16427,7 +16485,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "get",
|
||||
"weight": 393,
|
||||
"weight": 392,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16486,7 +16544,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "update",
|
||||
"weight": 395,
|
||||
"weight": 394,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16710,7 +16768,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "delete",
|
||||
"weight": 396,
|
||||
"weight": 395,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16854,7 +16912,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createDeployment",
|
||||
"weight": 398,
|
||||
"weight": 397,
|
||||
"cookies": false,
|
||||
"type": "upload",
|
||||
"deprecated": false,
|
||||
@@ -16933,6 +16991,109 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"\/sites\/{siteId}\/deployments\/template": {
|
||||
"post": {
|
||||
"summary": "Create deployment",
|
||||
"operationId": "sitesCreateTemplateDeployment",
|
||||
"tags": [
|
||||
"sites"
|
||||
],
|
||||
"description": "",
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "Deployment",
|
||||
"content": {
|
||||
"application\/json": {
|
||||
"schema": {
|
||||
"$ref": "#\/components\/schemas\/deployment"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTemplateDeployment",
|
||||
"weight": 398,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "sites\/create-template-deployment.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/server\/sites#listTemplates) to find the template details.",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
"scope": "sites.write",
|
||||
"platforms": [
|
||||
"server"
|
||||
],
|
||||
"packaging": false,
|
||||
"auth": {
|
||||
"Project": [],
|
||||
"Key": []
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"Project": [],
|
||||
"Key": []
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "siteId",
|
||||
"description": "Site ID.",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"x-example": "<SITE_ID>"
|
||||
},
|
||||
"in": "path"
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application\/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"repository": {
|
||||
"type": "string",
|
||||
"description": "Repository name of the template.",
|
||||
"x-example": "<REPOSITORY>"
|
||||
},
|
||||
"owner": {
|
||||
"type": "string",
|
||||
"description": "The name of the owner of the template.",
|
||||
"x-example": "<OWNER>"
|
||||
},
|
||||
"rootDirectory": {
|
||||
"type": "string",
|
||||
"description": "Path to site code in the template repo.",
|
||||
"x-example": "<ROOT_DIRECTORY>"
|
||||
},
|
||||
"version": {
|
||||
"type": "string",
|
||||
"description": "Version (tag) for the repo linked to the site template.",
|
||||
"x-example": "<VERSION>"
|
||||
},
|
||||
"activate": {
|
||||
"type": "boolean",
|
||||
"description": "Automatically activate the deployment when it is finished building.",
|
||||
"x-example": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"repository",
|
||||
"owner",
|
||||
"rootDirectory",
|
||||
"version"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"\/sites\/{siteId}\/deployments\/{deploymentId}": {
|
||||
"get": {
|
||||
"summary": "Get deployment",
|
||||
@@ -17751,7 +17912,7 @@
|
||||
},
|
||||
"secret": {
|
||||
"type": "boolean",
|
||||
"description": "Is secret? Secret variables can only be updated or deleted, they cannot be read.",
|
||||
"description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.",
|
||||
"x-example": false
|
||||
}
|
||||
},
|
||||
@@ -17918,6 +18079,11 @@
|
||||
"type": "string",
|
||||
"description": "Variable value. Max length: 8192 chars.",
|
||||
"x-example": "<VALUE>"
|
||||
},
|
||||
"secret": {
|
||||
"type": "boolean",
|
||||
"description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.",
|
||||
"x-example": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
||||
@@ -5198,7 +5198,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "query",
|
||||
"weight": 326,
|
||||
"weight": 324,
|
||||
"cookies": false,
|
||||
"type": "graphql",
|
||||
"deprecated": false,
|
||||
@@ -5271,7 +5271,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "mutation",
|
||||
"weight": 325,
|
||||
"weight": 323,
|
||||
"cookies": false,
|
||||
"type": "graphql",
|
||||
"deprecated": false,
|
||||
@@ -5768,7 +5768,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createSubscriber",
|
||||
"weight": 371,
|
||||
"weight": 369,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -5852,7 +5852,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "deleteSubscriber",
|
||||
"weight": 375,
|
||||
"weight": 373,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -8284,7 +8284,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "list",
|
||||
"weight": 389,
|
||||
"weight": 387,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -8356,7 +8356,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "create",
|
||||
"weight": 387,
|
||||
"weight": 385,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -8565,30 +8565,6 @@
|
||||
"default": "",
|
||||
"x-example": "<PROVIDER_ROOT_DIRECTORY>"
|
||||
},
|
||||
"templateRepository": {
|
||||
"type": "string",
|
||||
"description": "Repository name of the template.",
|
||||
"default": "",
|
||||
"x-example": "<TEMPLATE_REPOSITORY>"
|
||||
},
|
||||
"templateOwner": {
|
||||
"type": "string",
|
||||
"description": "The name of the owner of the template.",
|
||||
"default": "",
|
||||
"x-example": "<TEMPLATE_OWNER>"
|
||||
},
|
||||
"templateRootDirectory": {
|
||||
"type": "string",
|
||||
"description": "Path to function code in the template repo.",
|
||||
"default": "",
|
||||
"x-example": "<TEMPLATE_ROOT_DIRECTORY>"
|
||||
},
|
||||
"templateVersion": {
|
||||
"type": "string",
|
||||
"description": "Version (tag) for the repo linked to the function template.",
|
||||
"default": "",
|
||||
"x-example": "<TEMPLATE_VERSION>"
|
||||
},
|
||||
"specification": {
|
||||
"type": "string",
|
||||
"description": "Runtime specification for the function and builds.",
|
||||
@@ -8630,7 +8606,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listRuntimes",
|
||||
"weight": 390,
|
||||
"weight": 388,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -8792,7 +8768,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "update",
|
||||
"weight": 388,
|
||||
"weight": 386,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -9177,7 +9153,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createDeployment",
|
||||
"weight": 391,
|
||||
"weight": 389,
|
||||
"cookies": false,
|
||||
"type": "upload",
|
||||
"deprecated": false,
|
||||
@@ -9245,6 +9221,112 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"\/functions\/{functionId}\/deployments\/template": {
|
||||
"post": {
|
||||
"summary": "Create template deployment",
|
||||
"operationId": "functionsCreateTemplateDeployment",
|
||||
"consumes": [
|
||||
"application\/json"
|
||||
],
|
||||
"produces": [
|
||||
"application\/json"
|
||||
],
|
||||
"tags": [
|
||||
"functions"
|
||||
],
|
||||
"description": "",
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "Deployment",
|
||||
"schema": {
|
||||
"$ref": "#\/definitions\/deployment"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTemplateDeployment",
|
||||
"weight": 390,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "functions\/create-template-deployment.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/server\/functions#listTemplates) to find the template details.",
|
||||
"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": "payload",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"repository": {
|
||||
"type": "string",
|
||||
"description": "Repository name of the template.",
|
||||
"default": null,
|
||||
"x-example": "<REPOSITORY>"
|
||||
},
|
||||
"owner": {
|
||||
"type": "string",
|
||||
"description": "The name of the owner of the template.",
|
||||
"default": null,
|
||||
"x-example": "<OWNER>"
|
||||
},
|
||||
"rootDirectory": {
|
||||
"type": "string",
|
||||
"description": "Path to function code in the template repo.",
|
||||
"default": null,
|
||||
"x-example": "<ROOT_DIRECTORY>"
|
||||
},
|
||||
"version": {
|
||||
"type": "string",
|
||||
"description": "Version (tag) for the repo linked to the function template.",
|
||||
"default": null,
|
||||
"x-example": "<VERSION>"
|
||||
},
|
||||
"activate": {
|
||||
"type": "boolean",
|
||||
"description": "Automatically activate the deployment when it is finished building.",
|
||||
"default": false,
|
||||
"x-example": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"repository",
|
||||
"owner",
|
||||
"rootDirectory",
|
||||
"version"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"\/functions\/{functionId}\/deployments\/{deploymentId}": {
|
||||
"get": {
|
||||
"summary": "Get deployment",
|
||||
@@ -10004,8 +10086,8 @@
|
||||
},
|
||||
"secret": {
|
||||
"type": "boolean",
|
||||
"description": "Is secret? Secret variables can only be updated or deleted, they cannot be read.",
|
||||
"default": false,
|
||||
"description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.",
|
||||
"default": true,
|
||||
"x-example": false
|
||||
}
|
||||
},
|
||||
@@ -10042,7 +10124,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "query",
|
||||
"weight": 326,
|
||||
"weight": 324,
|
||||
"cookies": false,
|
||||
"type": "graphql",
|
||||
"deprecated": false,
|
||||
@@ -10117,7 +10199,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "mutation",
|
||||
"weight": 325,
|
||||
"weight": 323,
|
||||
"cookies": false,
|
||||
"type": "graphql",
|
||||
"deprecated": false,
|
||||
@@ -11939,7 +12021,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listMessages",
|
||||
"weight": 379,
|
||||
"weight": 377,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12014,7 +12096,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createEmail",
|
||||
"weight": 376,
|
||||
"weight": 374,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12172,7 +12254,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateEmail",
|
||||
"weight": 383,
|
||||
"weight": 381,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12327,7 +12409,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createPush",
|
||||
"weight": 378,
|
||||
"weight": 376,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12522,7 +12604,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updatePush",
|
||||
"weight": 385,
|
||||
"weight": 383,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12716,7 +12798,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createSms",
|
||||
"weight": 377,
|
||||
"weight": 375,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12834,7 +12916,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateSms",
|
||||
"weight": 384,
|
||||
"weight": 382,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -12950,7 +13032,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "getMessage",
|
||||
"weight": 382,
|
||||
"weight": 380,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13005,7 +13087,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "delete",
|
||||
"weight": 386,
|
||||
"weight": 384,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13067,7 +13149,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listMessageLogs",
|
||||
"weight": 380,
|
||||
"weight": 378,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13141,7 +13223,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listTargets",
|
||||
"weight": 381,
|
||||
"weight": 379,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13215,7 +13297,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listProviders",
|
||||
"weight": 351,
|
||||
"weight": 349,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13290,7 +13372,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createApnsProvider",
|
||||
"weight": 350,
|
||||
"weight": 348,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13405,7 +13487,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateApnsProvider",
|
||||
"weight": 363,
|
||||
"weight": 361,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13518,7 +13600,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createFcmProvider",
|
||||
"weight": 349,
|
||||
"weight": 347,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13609,7 +13691,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateFcmProvider",
|
||||
"weight": 362,
|
||||
"weight": 360,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13698,7 +13780,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createMailgunProvider",
|
||||
"weight": 341,
|
||||
"weight": 339,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13825,7 +13907,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateMailgunProvider",
|
||||
"weight": 354,
|
||||
"weight": 352,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -13950,7 +14032,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createMsg91Provider",
|
||||
"weight": 344,
|
||||
"weight": 342,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14053,7 +14135,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateMsg91Provider",
|
||||
"weight": 357,
|
||||
"weight": 355,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14154,7 +14236,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createSendgridProvider",
|
||||
"weight": 342,
|
||||
"weight": 340,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14269,7 +14351,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateSendgridProvider",
|
||||
"weight": 355,
|
||||
"weight": 353,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14382,7 +14464,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createSmtpProvider",
|
||||
"weight": 343,
|
||||
"weight": 341,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14541,7 +14623,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateSmtpProvider",
|
||||
"weight": 356,
|
||||
"weight": 354,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14697,7 +14779,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTelesignProvider",
|
||||
"weight": 345,
|
||||
"weight": 343,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14800,7 +14882,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateTelesignProvider",
|
||||
"weight": 358,
|
||||
"weight": 356,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -14901,7 +14983,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTextmagicProvider",
|
||||
"weight": 346,
|
||||
"weight": 344,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15004,7 +15086,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateTextmagicProvider",
|
||||
"weight": 359,
|
||||
"weight": 357,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15105,7 +15187,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTwilioProvider",
|
||||
"weight": 347,
|
||||
"weight": 345,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15208,7 +15290,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateTwilioProvider",
|
||||
"weight": 360,
|
||||
"weight": 358,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15309,7 +15391,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createVonageProvider",
|
||||
"weight": 348,
|
||||
"weight": 346,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15412,7 +15494,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateVonageProvider",
|
||||
"weight": 361,
|
||||
"weight": 359,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15513,7 +15595,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "getProvider",
|
||||
"weight": 353,
|
||||
"weight": 351,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15568,7 +15650,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "deleteProvider",
|
||||
"weight": 364,
|
||||
"weight": 362,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15630,7 +15712,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listProviderLogs",
|
||||
"weight": 352,
|
||||
"weight": 350,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15704,7 +15786,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listSubscriberLogs",
|
||||
"weight": 373,
|
||||
"weight": 371,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15778,7 +15860,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listTopics",
|
||||
"weight": 366,
|
||||
"weight": 364,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15851,7 +15933,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTopic",
|
||||
"weight": 365,
|
||||
"weight": 363,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -15941,7 +16023,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "getTopic",
|
||||
"weight": 368,
|
||||
"weight": 366,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16001,7 +16083,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "updateTopic",
|
||||
"weight": 369,
|
||||
"weight": 367,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16080,7 +16162,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "deleteTopic",
|
||||
"weight": 370,
|
||||
"weight": 368,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16142,7 +16224,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listTopicLogs",
|
||||
"weight": 367,
|
||||
"weight": 365,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16216,7 +16298,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listSubscribers",
|
||||
"weight": 372,
|
||||
"weight": 370,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16297,7 +16379,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createSubscriber",
|
||||
"weight": 371,
|
||||
"weight": 369,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16388,7 +16470,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "getSubscriber",
|
||||
"weight": 374,
|
||||
"weight": 372,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16451,7 +16533,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "deleteSubscriber",
|
||||
"weight": 375,
|
||||
"weight": 373,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16525,7 +16607,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "list",
|
||||
"weight": 394,
|
||||
"weight": 393,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16597,7 +16679,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "create",
|
||||
"weight": 392,
|
||||
"weight": 391,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16688,12 +16770,6 @@
|
||||
"default": "",
|
||||
"x-example": "<OUTPUT_DIRECTORY>"
|
||||
},
|
||||
"subdomain": {
|
||||
"type": "string",
|
||||
"description": "Unique custom sub-domain. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
|
||||
"default": "",
|
||||
"x-example": "<SUBDOMAIN>"
|
||||
},
|
||||
"buildRuntime": {
|
||||
"type": "string",
|
||||
"description": "Runtime to use during build step.",
|
||||
@@ -16808,30 +16884,6 @@
|
||||
"default": "",
|
||||
"x-example": "<PROVIDER_ROOT_DIRECTORY>"
|
||||
},
|
||||
"templateRepository": {
|
||||
"type": "string",
|
||||
"description": "Repository name of the template.",
|
||||
"default": "",
|
||||
"x-example": "<TEMPLATE_REPOSITORY>"
|
||||
},
|
||||
"templateOwner": {
|
||||
"type": "string",
|
||||
"description": "The name of the owner of the template.",
|
||||
"default": "",
|
||||
"x-example": "<TEMPLATE_OWNER>"
|
||||
},
|
||||
"templateRootDirectory": {
|
||||
"type": "string",
|
||||
"description": "Path to site code in the template repo.",
|
||||
"default": "",
|
||||
"x-example": "<TEMPLATE_ROOT_DIRECTORY>"
|
||||
},
|
||||
"templateVersion": {
|
||||
"type": "string",
|
||||
"description": "Version (tag) for the repo linked to the site template.",
|
||||
"default": "",
|
||||
"x-example": "<TEMPLATE_VERSION>"
|
||||
},
|
||||
"specification": {
|
||||
"type": "string",
|
||||
"description": "Framework specification for the site and builds.",
|
||||
@@ -16874,7 +16926,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "listFrameworks",
|
||||
"weight": 397,
|
||||
"weight": 396,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16925,7 +16977,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "get",
|
||||
"weight": 393,
|
||||
"weight": 392,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -16984,7 +17036,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "update",
|
||||
"weight": 395,
|
||||
"weight": 394,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -17224,7 +17276,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "delete",
|
||||
"weight": 396,
|
||||
"weight": 395,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
@@ -17365,7 +17417,7 @@
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createDeployment",
|
||||
"weight": 398,
|
||||
"weight": 397,
|
||||
"cookies": false,
|
||||
"type": "upload",
|
||||
"deprecated": false,
|
||||
@@ -17441,6 +17493,112 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"\/sites\/{siteId}\/deployments\/template": {
|
||||
"post": {
|
||||
"summary": "Create deployment",
|
||||
"operationId": "sitesCreateTemplateDeployment",
|
||||
"consumes": [
|
||||
"application\/json"
|
||||
],
|
||||
"produces": [
|
||||
"application\/json"
|
||||
],
|
||||
"tags": [
|
||||
"sites"
|
||||
],
|
||||
"description": "",
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "Deployment",
|
||||
"schema": {
|
||||
"$ref": "#\/definitions\/deployment"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-appwrite": {
|
||||
"method": "createTemplateDeployment",
|
||||
"weight": 398,
|
||||
"cookies": false,
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "sites\/create-template-deployment.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/server\/sites#listTemplates) to find the template details.",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
"scope": "sites.write",
|
||||
"platforms": [
|
||||
"server"
|
||||
],
|
||||
"packaging": false,
|
||||
"auth": {
|
||||
"Project": [],
|
||||
"Key": []
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"Project": [],
|
||||
"Key": []
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "siteId",
|
||||
"description": "Site ID.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"x-example": "<SITE_ID>",
|
||||
"in": "path"
|
||||
},
|
||||
{
|
||||
"name": "payload",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"repository": {
|
||||
"type": "string",
|
||||
"description": "Repository name of the template.",
|
||||
"default": null,
|
||||
"x-example": "<REPOSITORY>"
|
||||
},
|
||||
"owner": {
|
||||
"type": "string",
|
||||
"description": "The name of the owner of the template.",
|
||||
"default": null,
|
||||
"x-example": "<OWNER>"
|
||||
},
|
||||
"rootDirectory": {
|
||||
"type": "string",
|
||||
"description": "Path to site code in the template repo.",
|
||||
"default": null,
|
||||
"x-example": "<ROOT_DIRECTORY>"
|
||||
},
|
||||
"version": {
|
||||
"type": "string",
|
||||
"description": "Version (tag) for the repo linked to the site template.",
|
||||
"default": null,
|
||||
"x-example": "<VERSION>"
|
||||
},
|
||||
"activate": {
|
||||
"type": "boolean",
|
||||
"description": "Automatically activate the deployment when it is finished building.",
|
||||
"default": false,
|
||||
"x-example": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"repository",
|
||||
"owner",
|
||||
"rootDirectory",
|
||||
"version"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"\/sites\/{siteId}\/deployments\/{deploymentId}": {
|
||||
"get": {
|
||||
"summary": "Get deployment",
|
||||
@@ -18266,8 +18424,8 @@
|
||||
},
|
||||
"secret": {
|
||||
"type": "boolean",
|
||||
"description": "Is secret? Secret variables can only be updated or deleted, they cannot be read.",
|
||||
"default": false,
|
||||
"description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.",
|
||||
"default": true,
|
||||
"x-example": false
|
||||
}
|
||||
},
|
||||
@@ -18430,6 +18588,12 @@
|
||||
"description": "Variable value. Max length: 8192 chars.",
|
||||
"default": null,
|
||||
"x-example": "<VALUE>"
|
||||
},
|
||||
"secret": {
|
||||
"type": "boolean",
|
||||
"description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.",
|
||||
"default": null,
|
||||
"x-example": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
||||
Reference in New Issue
Block a user