From 05771c46d66057161c7579411fa4852ec2139244 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Ba=C4=8Do?= Date: Sun, 9 Mar 2025 00:02:39 +0100 Subject: [PATCH] Update specs --- app/config/specs/open-api3-latest-client.json | 202 +- .../specs/open-api3-latest-console.json | 2524 ++++++++++------- app/config/specs/open-api3-latest-server.json | 1816 +++++++----- app/config/specs/swagger2-latest-client.json | 202 +- app/config/specs/swagger2-latest-console.json | 2514 +++++++++------- app/config/specs/swagger2-latest-server.json | 1808 +++++++----- 6 files changed, 5481 insertions(+), 3585 deletions(-) diff --git a/app/config/specs/open-api3-latest-client.json b/app/config/specs/open-api3-latest-client.json index 05b38d5cbf..426e85c709 100644 --- a/app/config/specs/open-api3-latest-client.json +++ b/app/config/specs/open-api3-latest-client.json @@ -43,7 +43,7 @@ }, "x-appwrite": { "method": "get", - "weight": 9, + "weight": 10, "cookies": false, "type": "", "deprecated": false, @@ -91,7 +91,7 @@ }, "x-appwrite": { "method": "create", - "weight": 8, + "weight": 9, "cookies": false, "type": "", "deprecated": false, @@ -175,7 +175,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 34, + "weight": 35, "cookies": false, "type": "", "deprecated": false, @@ -250,7 +250,7 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 57, + "weight": 58, "cookies": false, "type": "", "deprecated": false, @@ -308,7 +308,7 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 58, + "weight": 59, "cookies": false, "type": "", "deprecated": false, @@ -370,7 +370,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 29, + "weight": 30, "cookies": false, "type": "", "deprecated": false, @@ -418,7 +418,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 31, + "weight": 32, "cookies": false, "type": "", "deprecated": false, @@ -483,7 +483,7 @@ }, "x-appwrite": { "method": "updateMFA", - "weight": 44, + "weight": 45, "cookies": false, "type": "", "deprecated": false, @@ -552,7 +552,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", - "weight": 46, + "weight": 47, "cookies": false, "type": "", "deprecated": false, @@ -617,7 +617,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", - "weight": 47, + "weight": 48, "cookies": false, "type": "", "deprecated": false, @@ -694,7 +694,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 51, + "weight": 52, "cookies": false, "type": "", "deprecated": false, @@ -761,7 +761,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", - "weight": 52, + "weight": 53, "cookies": false, "type": "", "deprecated": false, @@ -834,7 +834,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", - "weight": 53, + "weight": 54, "cookies": false, "type": "", "deprecated": false, @@ -909,7 +909,7 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 45, + "weight": 46, "cookies": false, "type": "", "deprecated": false, @@ -959,7 +959,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 50, + "weight": 51, "cookies": false, "type": "", "deprecated": false, @@ -1007,7 +1007,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 48, + "weight": 49, "cookies": false, "type": "", "deprecated": false, @@ -1055,7 +1055,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 49, + "weight": 50, "cookies": false, "type": "", "deprecated": false, @@ -1105,7 +1105,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 32, + "weight": 33, "cookies": false, "type": "", "deprecated": false, @@ -1174,7 +1174,7 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 33, + "weight": 34, "cookies": false, "type": "", "deprecated": false, @@ -1248,7 +1248,7 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 35, + "weight": 36, "cookies": false, "type": "", "deprecated": false, @@ -1323,7 +1323,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 30, + "weight": 31, "cookies": false, "type": "", "deprecated": false, @@ -1371,7 +1371,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 36, + "weight": 37, "cookies": false, "type": "", "deprecated": false, @@ -1440,7 +1440,7 @@ }, "x-appwrite": { "method": "createRecovery", - "weight": 38, + "weight": 39, "cookies": false, "type": "", "deprecated": false, @@ -1516,7 +1516,7 @@ }, "x-appwrite": { "method": "updateRecovery", - "weight": 39, + "weight": 40, "cookies": false, "type": "", "deprecated": false, @@ -1597,7 +1597,7 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 11, + "weight": 12, "cookies": false, "type": "", "deprecated": false, @@ -1638,7 +1638,7 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 12, + "weight": 13, "cookies": false, "type": "", "deprecated": false, @@ -1688,7 +1688,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", - "weight": 17, + "weight": 18, "cookies": false, "type": "", "deprecated": false, @@ -1736,7 +1736,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", - "weight": 16, + "weight": 17, "cookies": false, "type": "", "deprecated": false, @@ -1809,7 +1809,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", - "weight": 26, + "weight": 27, "cookies": false, "type": "", "deprecated": true, @@ -1875,7 +1875,7 @@ }, "x-appwrite": { "method": "createOAuth2Session", - "weight": 19, + "weight": 20, "cookies": false, "type": "webAuth", "deprecated": false, @@ -2015,7 +2015,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", - "weight": 27, + "weight": 28, "cookies": false, "type": "", "deprecated": true, @@ -2088,7 +2088,7 @@ }, "x-appwrite": { "method": "createSession", - "weight": 18, + "weight": 19, "cookies": false, "type": "", "deprecated": false, @@ -2161,7 +2161,7 @@ }, "x-appwrite": { "method": "getSession", - "weight": 13, + "weight": 14, "cookies": false, "type": "", "deprecated": false, @@ -2221,7 +2221,7 @@ }, "x-appwrite": { "method": "updateSession", - "weight": 15, + "weight": 16, "cookies": false, "type": "", "deprecated": false, @@ -2274,7 +2274,7 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 14, + "weight": 15, "cookies": false, "type": "", "deprecated": false, @@ -2336,7 +2336,7 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 37, + "weight": 38, "cookies": false, "type": "", "deprecated": false, @@ -2386,7 +2386,7 @@ }, "x-appwrite": { "method": "createPushTarget", - "weight": 54, + "weight": 55, "cookies": false, "type": "", "deprecated": false, @@ -2464,7 +2464,7 @@ }, "x-appwrite": { "method": "updatePushTarget", - "weight": 55, + "weight": 56, "cookies": false, "type": "", "deprecated": false, @@ -2534,7 +2534,7 @@ }, "x-appwrite": { "method": "deletePushTarget", - "weight": 56, + "weight": 57, "cookies": false, "type": "", "deprecated": false, @@ -2594,7 +2594,7 @@ }, "x-appwrite": { "method": "createEmailToken", - "weight": 25, + "weight": 26, "cookies": false, "type": "", "deprecated": false, @@ -2672,7 +2672,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", - "weight": 24, + "weight": 25, "cookies": false, "type": "", "deprecated": false, @@ -2751,7 +2751,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", - "weight": 23, + "weight": 24, "cookies": false, "type": "webAuth", "deprecated": false, @@ -2891,7 +2891,7 @@ }, "x-appwrite": { "method": "createPhoneToken", - "weight": 28, + "weight": 29, "cookies": false, "type": "", "deprecated": false, @@ -2967,7 +2967,7 @@ }, "x-appwrite": { "method": "createVerification", - "weight": 40, + "weight": 41, "cookies": false, "type": "", "deprecated": false, @@ -3034,7 +3034,7 @@ }, "x-appwrite": { "method": "updateVerification", - "weight": 41, + "weight": 42, "cookies": false, "type": "", "deprecated": false, @@ -3109,7 +3109,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", - "weight": 42, + "weight": 43, "cookies": false, "type": "", "deprecated": false, @@ -3160,7 +3160,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 43, + "weight": 44, "cookies": false, "type": "", "deprecated": false, @@ -3228,7 +3228,7 @@ }, "x-appwrite": { "method": "getBrowser", - "weight": 60, + "weight": 61, "cookies": false, "type": "location", "deprecated": false, @@ -3353,7 +3353,7 @@ }, "x-appwrite": { "method": "getCreditCard", - "weight": 59, + "weight": 60, "cookies": false, "type": "location", "deprecated": false, @@ -3484,7 +3484,7 @@ }, "x-appwrite": { "method": "getFavicon", - "weight": 63, + "weight": 64, "cookies": false, "type": "location", "deprecated": false, @@ -3541,7 +3541,7 @@ }, "x-appwrite": { "method": "getFlag", - "weight": 61, + "weight": 62, "cookies": false, "type": "location", "deprecated": false, @@ -4028,7 +4028,7 @@ }, "x-appwrite": { "method": "getImage", - "weight": 62, + "weight": 63, "cookies": false, "type": "location", "deprecated": false, @@ -4109,7 +4109,7 @@ }, "x-appwrite": { "method": "getInitials", - "weight": 65, + "weight": 66, "cookies": false, "type": "location", "deprecated": false, @@ -4200,7 +4200,7 @@ }, "x-appwrite": { "method": "getQR", - "weight": 64, + "weight": 65, "cookies": false, "type": "location", "deprecated": false, @@ -4298,7 +4298,7 @@ }, "x-appwrite": { "method": "listDocuments", - "weight": 109, + "weight": 110, "cookies": false, "type": "", "deprecated": false, @@ -4382,7 +4382,7 @@ }, "x-appwrite": { "method": "createDocument", - "weight": 108, + "weight": 109, "cookies": false, "type": "", "deprecated": false, @@ -4488,7 +4488,7 @@ }, "x-appwrite": { "method": "getDocument", - "weight": 110, + "weight": 111, "cookies": false, "type": "", "deprecated": false, @@ -4582,7 +4582,7 @@ }, "x-appwrite": { "method": "updateDocument", - "weight": 112, + "weight": 113, "cookies": false, "type": "", "deprecated": false, @@ -4680,7 +4680,7 @@ }, "x-appwrite": { "method": "deleteDocument", - "weight": 113, + "weight": 114, "cookies": false, "type": "", "deprecated": false, @@ -4748,7 +4748,7 @@ "tags": [ "functions" ], - "description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.", + "description": "", "responses": { "200": { "description": "Executions List", @@ -4763,12 +4763,12 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 301, + "weight": 383, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-executions.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the current user function execution logs. You can use the query params to filter your results.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -4833,7 +4833,7 @@ "tags": [ "functions" ], - "description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", + "description": "", "responses": { "201": { "description": "Execution", @@ -4848,12 +4848,12 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 300, + "weight": 381, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/create-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterTrigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -4947,7 +4947,7 @@ "tags": [ "functions" ], - "description": "Get a function execution log by its unique ID.", + "description": "", "responses": { "200": { "description": "Execution", @@ -4962,12 +4962,12 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 302, + "weight": 382, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function execution log by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -5035,7 +5035,7 @@ }, "x-appwrite": { "method": "query", - "weight": 325, + "weight": 303, "cookies": false, "type": "graphql", "deprecated": false, @@ -5086,7 +5086,7 @@ }, "x-appwrite": { "method": "mutation", - "weight": 324, + "weight": 302, "cookies": false, "type": "graphql", "deprecated": false, @@ -5137,7 +5137,7 @@ }, "x-appwrite": { "method": "get", - "weight": 117, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -5188,7 +5188,7 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 118, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -5239,7 +5239,7 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 122, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -5290,7 +5290,7 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 119, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -5341,7 +5341,7 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 120, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -5392,7 +5392,7 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 121, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -5443,7 +5443,7 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 123, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -5494,7 +5494,7 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 124, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -5545,7 +5545,7 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 370, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -5627,7 +5627,7 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 374, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -5701,7 +5701,7 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 208, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -5786,7 +5786,7 @@ }, "x-appwrite": { "method": "createFile", - "weight": 207, + "weight": 208, "cookies": false, "type": "upload", "deprecated": false, @@ -5883,7 +5883,7 @@ }, "x-appwrite": { "method": "getFile", - "weight": 209, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -5954,7 +5954,7 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 214, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -6042,7 +6042,7 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 215, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -6108,7 +6108,7 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 211, + "weight": 212, "cookies": false, "type": "location", "deprecated": false, @@ -6174,7 +6174,7 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 210, + "weight": 211, "cookies": false, "type": "location", "deprecated": false, @@ -6390,7 +6390,7 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 212, + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -6463,7 +6463,7 @@ }, "x-appwrite": { "method": "list", - "weight": 219, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -6538,7 +6538,7 @@ }, "x-appwrite": { "method": "create", - "weight": 218, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -6622,7 +6622,7 @@ }, "x-appwrite": { "method": "get", - "weight": 220, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -6683,7 +6683,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 222, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -6756,7 +6756,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 224, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -6819,7 +6819,7 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 226, + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -6904,7 +6904,7 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 225, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -7014,7 +7014,7 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 227, + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -7085,7 +7085,7 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 228, + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -7171,7 +7171,7 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 230, + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -7244,7 +7244,7 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 229, + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -7341,7 +7341,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 221, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -7401,7 +7401,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 223, + "weight": 224, "cookies": false, "type": "", "deprecated": false, diff --git a/app/config/specs/open-api3-latest-console.json b/app/config/specs/open-api3-latest-console.json index 6be9d6e5e0..4d0b904c2a 100644 --- a/app/config/specs/open-api3-latest-console.json +++ b/app/config/specs/open-api3-latest-console.json @@ -43,7 +43,7 @@ }, "x-appwrite": { "method": "get", - "weight": 9, + "weight": 10, "cookies": false, "type": "", "deprecated": false, @@ -90,7 +90,7 @@ }, "x-appwrite": { "method": "create", - "weight": 8, + "weight": 9, "cookies": false, "type": "", "deprecated": false, @@ -165,7 +165,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 10, + "weight": 11, "cookies": false, "type": "", "deprecated": false, @@ -212,7 +212,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 34, + "weight": 35, "cookies": false, "type": "", "deprecated": false, @@ -286,7 +286,7 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 57, + "weight": 58, "cookies": false, "type": "", "deprecated": false, @@ -343,7 +343,7 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 58, + "weight": 59, "cookies": false, "type": "", "deprecated": false, @@ -404,7 +404,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 29, + "weight": 30, "cookies": false, "type": "", "deprecated": false, @@ -452,7 +452,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 31, + "weight": 32, "cookies": false, "type": "", "deprecated": false, @@ -516,7 +516,7 @@ }, "x-appwrite": { "method": "updateMFA", - "weight": 44, + "weight": 45, "cookies": false, "type": "", "deprecated": false, @@ -584,7 +584,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", - "weight": 46, + "weight": 47, "cookies": false, "type": "", "deprecated": false, @@ -648,7 +648,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", - "weight": 47, + "weight": 48, "cookies": false, "type": "", "deprecated": false, @@ -724,7 +724,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 51, + "weight": 52, "cookies": false, "type": "", "deprecated": false, @@ -790,7 +790,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", - "weight": 52, + "weight": 53, "cookies": false, "type": "", "deprecated": false, @@ -863,7 +863,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", - "weight": 53, + "weight": 54, "cookies": false, "type": "", "deprecated": false, @@ -937,7 +937,7 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 45, + "weight": 46, "cookies": false, "type": "", "deprecated": false, @@ -986,7 +986,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 50, + "weight": 51, "cookies": false, "type": "", "deprecated": false, @@ -1033,7 +1033,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 48, + "weight": 49, "cookies": false, "type": "", "deprecated": false, @@ -1080,7 +1080,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 49, + "weight": 50, "cookies": false, "type": "", "deprecated": false, @@ -1129,7 +1129,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 32, + "weight": 33, "cookies": false, "type": "", "deprecated": false, @@ -1197,7 +1197,7 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 33, + "weight": 34, "cookies": false, "type": "", "deprecated": false, @@ -1270,7 +1270,7 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 35, + "weight": 36, "cookies": false, "type": "", "deprecated": false, @@ -1344,7 +1344,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 30, + "weight": 31, "cookies": false, "type": "", "deprecated": false, @@ -1391,7 +1391,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 36, + "weight": 37, "cookies": false, "type": "", "deprecated": false, @@ -1459,7 +1459,7 @@ }, "x-appwrite": { "method": "createRecovery", - "weight": 38, + "weight": 39, "cookies": false, "type": "", "deprecated": false, @@ -1534,7 +1534,7 @@ }, "x-appwrite": { "method": "updateRecovery", - "weight": 39, + "weight": 40, "cookies": false, "type": "", "deprecated": false, @@ -1614,7 +1614,7 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 11, + "weight": 12, "cookies": false, "type": "", "deprecated": false, @@ -1654,7 +1654,7 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 12, + "weight": 13, "cookies": false, "type": "", "deprecated": false, @@ -1703,7 +1703,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", - "weight": 17, + "weight": 18, "cookies": false, "type": "", "deprecated": false, @@ -1751,7 +1751,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", - "weight": 16, + "weight": 17, "cookies": false, "type": "", "deprecated": false, @@ -1824,7 +1824,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", - "weight": 26, + "weight": 27, "cookies": false, "type": "", "deprecated": true, @@ -1890,7 +1890,7 @@ }, "x-appwrite": { "method": "createOAuth2Session", - "weight": 19, + "weight": 20, "cookies": false, "type": "webAuth", "deprecated": false, @@ -2030,7 +2030,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", - "weight": 27, + "weight": 28, "cookies": false, "type": "", "deprecated": true, @@ -2103,7 +2103,7 @@ }, "x-appwrite": { "method": "createSession", - "weight": 18, + "weight": 19, "cookies": false, "type": "", "deprecated": false, @@ -2176,7 +2176,7 @@ }, "x-appwrite": { "method": "getSession", - "weight": 13, + "weight": 14, "cookies": false, "type": "", "deprecated": false, @@ -2235,7 +2235,7 @@ }, "x-appwrite": { "method": "updateSession", - "weight": 15, + "weight": 16, "cookies": false, "type": "", "deprecated": false, @@ -2287,7 +2287,7 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 14, + "weight": 15, "cookies": false, "type": "", "deprecated": false, @@ -2348,7 +2348,7 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 37, + "weight": 38, "cookies": false, "type": "", "deprecated": false, @@ -2397,7 +2397,7 @@ }, "x-appwrite": { "method": "createPushTarget", - "weight": 54, + "weight": 55, "cookies": false, "type": "", "deprecated": false, @@ -2474,7 +2474,7 @@ }, "x-appwrite": { "method": "updatePushTarget", - "weight": 55, + "weight": 56, "cookies": false, "type": "", "deprecated": false, @@ -2543,7 +2543,7 @@ }, "x-appwrite": { "method": "deletePushTarget", - "weight": 56, + "weight": 57, "cookies": false, "type": "", "deprecated": false, @@ -2602,7 +2602,7 @@ }, "x-appwrite": { "method": "createEmailToken", - "weight": 25, + "weight": 26, "cookies": false, "type": "", "deprecated": false, @@ -2680,7 +2680,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", - "weight": 24, + "weight": 25, "cookies": false, "type": "", "deprecated": false, @@ -2759,7 +2759,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", - "weight": 23, + "weight": 24, "cookies": false, "type": "webAuth", "deprecated": false, @@ -2899,7 +2899,7 @@ }, "x-appwrite": { "method": "createPhoneToken", - "weight": 28, + "weight": 29, "cookies": false, "type": "", "deprecated": false, @@ -2975,7 +2975,7 @@ }, "x-appwrite": { "method": "createVerification", - "weight": 40, + "weight": 41, "cookies": false, "type": "", "deprecated": false, @@ -3041,7 +3041,7 @@ }, "x-appwrite": { "method": "updateVerification", - "weight": 41, + "weight": 42, "cookies": false, "type": "", "deprecated": false, @@ -3115,7 +3115,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", - "weight": 42, + "weight": 43, "cookies": false, "type": "", "deprecated": false, @@ -3165,7 +3165,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 43, + "weight": 44, "cookies": false, "type": "", "deprecated": false, @@ -3232,7 +3232,7 @@ }, "x-appwrite": { "method": "getBrowser", - "weight": 60, + "weight": 61, "cookies": false, "type": "location", "deprecated": false, @@ -3357,7 +3357,7 @@ }, "x-appwrite": { "method": "getCreditCard", - "weight": 59, + "weight": 60, "cookies": false, "type": "location", "deprecated": false, @@ -3488,7 +3488,7 @@ }, "x-appwrite": { "method": "getFavicon", - "weight": 63, + "weight": 64, "cookies": false, "type": "location", "deprecated": false, @@ -3545,7 +3545,7 @@ }, "x-appwrite": { "method": "getFlag", - "weight": 61, + "weight": 62, "cookies": false, "type": "location", "deprecated": false, @@ -4032,7 +4032,7 @@ }, "x-appwrite": { "method": "getImage", - "weight": 62, + "weight": 63, "cookies": false, "type": "location", "deprecated": false, @@ -4113,7 +4113,7 @@ }, "x-appwrite": { "method": "getInitials", - "weight": 65, + "weight": 66, "cookies": false, "type": "location", "deprecated": false, @@ -4204,7 +4204,7 @@ }, "x-appwrite": { "method": "getQR", - "weight": 64, + "weight": 65, "cookies": false, "type": "location", "deprecated": false, @@ -4295,7 +4295,7 @@ }, "x-appwrite": { "method": "chat", - "weight": 327, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -4354,7 +4354,7 @@ }, "x-appwrite": { "method": "getResource", - "weight": 422, + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -4428,7 +4428,7 @@ }, "x-appwrite": { "method": "variables", - "weight": 326, + "weight": 304, "cookies": false, "type": "", "deprecated": false, @@ -4475,7 +4475,7 @@ }, "x-appwrite": { "method": "list", - "weight": 70, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -4547,7 +4547,7 @@ }, "x-appwrite": { "method": "create", - "weight": 69, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -4625,7 +4625,7 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 114, + "weight": 115, "cookies": false, "type": "", "deprecated": false, @@ -4696,7 +4696,7 @@ }, "x-appwrite": { "method": "get", - "weight": 71, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -4754,7 +4754,7 @@ }, "x-appwrite": { "method": "update", - "weight": 73, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -4829,7 +4829,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 74, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -4889,7 +4889,7 @@ }, "x-appwrite": { "method": "listCollections", - "weight": 76, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -4971,7 +4971,7 @@ }, "x-appwrite": { "method": "createCollection", - "weight": 75, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -5074,7 +5074,7 @@ }, "x-appwrite": { "method": "getCollection", - "weight": 77, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -5142,7 +5142,7 @@ }, "x-appwrite": { "method": "updateCollection", - "weight": 79, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -5240,7 +5240,7 @@ }, "x-appwrite": { "method": "deleteCollection", - "weight": 80, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -5310,7 +5310,7 @@ }, "x-appwrite": { "method": "listAttributes", - "weight": 91, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -5393,7 +5393,7 @@ }, "x-appwrite": { "method": "createBooleanAttribute", - "weight": 88, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -5498,7 +5498,7 @@ }, "x-appwrite": { "method": "updateBooleanAttribute", - "weight": 100, + "weight": 101, "cookies": false, "type": "", "deprecated": false, @@ -5608,7 +5608,7 @@ }, "x-appwrite": { "method": "createDatetimeAttribute", - "weight": 89, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -5713,7 +5713,7 @@ }, "x-appwrite": { "method": "updateDatetimeAttribute", - "weight": 101, + "weight": 102, "cookies": false, "type": "", "deprecated": false, @@ -5823,7 +5823,7 @@ }, "x-appwrite": { "method": "createEmailAttribute", - "weight": 82, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -5928,7 +5928,7 @@ }, "x-appwrite": { "method": "updateEmailAttribute", - "weight": 94, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -6038,7 +6038,7 @@ }, "x-appwrite": { "method": "createEnumAttribute", - "weight": 83, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -6152,7 +6152,7 @@ }, "x-appwrite": { "method": "updateEnumAttribute", - "weight": 95, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -6271,7 +6271,7 @@ }, "x-appwrite": { "method": "createFloatAttribute", - "weight": 87, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -6386,7 +6386,7 @@ }, "x-appwrite": { "method": "updateFloatAttribute", - "weight": 99, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -6508,7 +6508,7 @@ }, "x-appwrite": { "method": "createIntegerAttribute", - "weight": 86, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -6623,7 +6623,7 @@ }, "x-appwrite": { "method": "updateIntegerAttribute", - "weight": 98, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -6745,7 +6745,7 @@ }, "x-appwrite": { "method": "createIpAttribute", - "weight": 84, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -6850,7 +6850,7 @@ }, "x-appwrite": { "method": "updateIpAttribute", - "weight": 96, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -6960,7 +6960,7 @@ }, "x-appwrite": { "method": "createRelationshipAttribute", - "weight": 90, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -7090,7 +7090,7 @@ }, "x-appwrite": { "method": "createStringAttribute", - "weight": 81, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -7206,7 +7206,7 @@ }, "x-appwrite": { "method": "updateStringAttribute", - "weight": 93, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -7321,7 +7321,7 @@ }, "x-appwrite": { "method": "createUrlAttribute", - "weight": 85, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -7426,7 +7426,7 @@ }, "x-appwrite": { "method": "updateUrlAttribute", - "weight": 97, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -7567,7 +7567,7 @@ }, "x-appwrite": { "method": "getAttribute", - "weight": 92, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -7637,7 +7637,7 @@ }, "x-appwrite": { "method": "deleteAttribute", - "weight": 103, + "weight": 104, "cookies": false, "type": "", "deprecated": false, @@ -7716,7 +7716,7 @@ }, "x-appwrite": { "method": "updateRelationshipAttribute", - "weight": 102, + "weight": 103, "cookies": false, "type": "", "deprecated": false, @@ -7823,7 +7823,7 @@ }, "x-appwrite": { "method": "listDocuments", - "weight": 109, + "weight": 110, "cookies": false, "type": "", "deprecated": false, @@ -7907,7 +7907,7 @@ }, "x-appwrite": { "method": "createDocument", - "weight": 108, + "weight": 109, "cookies": false, "type": "", "deprecated": false, @@ -8013,7 +8013,7 @@ }, "x-appwrite": { "method": "getDocument", - "weight": 110, + "weight": 111, "cookies": false, "type": "", "deprecated": false, @@ -8107,7 +8107,7 @@ }, "x-appwrite": { "method": "updateDocument", - "weight": 112, + "weight": 113, "cookies": false, "type": "", "deprecated": false, @@ -8205,7 +8205,7 @@ }, "x-appwrite": { "method": "deleteDocument", - "weight": 113, + "weight": 114, "cookies": false, "type": "", "deprecated": false, @@ -8288,7 +8288,7 @@ }, "x-appwrite": { "method": "listDocumentLogs", - "weight": 111, + "weight": 112, "cookies": false, "type": "", "deprecated": false, @@ -8380,7 +8380,7 @@ }, "x-appwrite": { "method": "listIndexes", - "weight": 105, + "weight": 106, "cookies": false, "type": "", "deprecated": false, @@ -8461,7 +8461,7 @@ }, "x-appwrite": { "method": "createIndex", - "weight": 104, + "weight": 105, "cookies": false, "type": "", "deprecated": false, @@ -8580,7 +8580,7 @@ }, "x-appwrite": { "method": "getIndex", - "weight": 106, + "weight": 107, "cookies": false, "type": "", "deprecated": false, @@ -8650,7 +8650,7 @@ }, "x-appwrite": { "method": "deleteIndex", - "weight": 107, + "weight": 108, "cookies": false, "type": "", "deprecated": false, @@ -8729,7 +8729,7 @@ }, "x-appwrite": { "method": "listCollectionLogs", - "weight": 78, + "weight": 79, "cookies": false, "type": "", "deprecated": false, @@ -8811,7 +8811,7 @@ }, "x-appwrite": { "method": "getCollectionUsage", - "weight": 116, + "weight": 117, "cookies": false, "type": "", "deprecated": false, @@ -8902,7 +8902,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 72, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -8974,7 +8974,7 @@ }, "x-appwrite": { "method": "getDatabaseUsage", - "weight": 115, + "weight": 116, "cookies": false, "type": "", "deprecated": false, @@ -9055,7 +9055,7 @@ }, "x-appwrite": { "method": "list", - "weight": 388, + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -9127,7 +9127,7 @@ }, "x-appwrite": { "method": "create", - "weight": 386, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -9232,8 +9232,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -9356,7 +9355,7 @@ }, "x-appwrite": { "method": "listRuntimes", - "weight": 389, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -9384,12 +9383,12 @@ }, "\/functions\/specifications": { "get": { - "summary": "List available function runtime specifications", + "summary": "List specifications", "operationId": "functionsListSpecifications", "tags": [ "functions" ], - "description": "List allowed function specifications for this instance.\n", + "description": "", "responses": { "200": { "description": "Specifications List", @@ -9404,12 +9403,12 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 288, + "weight": 370, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-specifications.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-specifications.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed function specifications for this instance.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9433,12 +9432,12 @@ }, "\/functions\/templates": { "get": { - "summary": "List function templates", + "summary": "List templates", "operationId": "functionsListTemplates", "tags": [ "functions" ], - "description": "List available function templates. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.", + "description": "", "responses": { "200": { "description": "Function Templates List", @@ -9453,12 +9452,12 @@ }, "x-appwrite": { "method": "listTemplates", - "weight": 309, + "weight": 393, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-templates.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-templates.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList available function templates. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9537,7 +9536,7 @@ "tags": [ "functions" ], - "description": "Get a function template using ID. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.", + "description": "", "responses": { "200": { "description": "Template Function", @@ -9552,12 +9551,12 @@ }, "x-appwrite": { "method": "getTemplate", - "weight": 310, + "weight": 392, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-template.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function template using ID. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9592,11 +9591,11 @@ "\/functions\/usage": { "get": { "summary": "Get functions usage", - "operationId": "functionsGetUsage", + "operationId": "functionsListUsage", "tags": [ "functions" ], - "description": "Get usage metrics and statistics for a for all functions. View statistics including total functions, deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", + "description": "", "responses": { "200": { "description": "UsageFunctions", @@ -9610,13 +9609,13 @@ } }, "x-appwrite": { - "method": "getUsage", - "weight": 291, + "method": "listUsage", + "weight": 386, "cookies": false, "type": "", "deprecated": false, - "demo": "functions\/get-usage.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-functions-usage.md", + "demo": "functions\/list-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet usage metrics and statistics for all functions in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9647,12 +9646,8 @@ "30d", "90d" ], - "x-enum-name": "FunctionUsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], + "x-enum-name": null, + "x-enum-keys": [], "default": "30d" }, "in": "query" @@ -9667,7 +9662,7 @@ "tags": [ "functions" ], - "description": "Get a function by its unique ID.", + "description": "", "responses": { "200": { "description": "Function", @@ -9682,12 +9677,12 @@ }, "x-appwrite": { "method": "get", - "weight": 289, + "weight": 365, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9740,7 +9735,7 @@ }, "x-appwrite": { "method": "update", - "weight": 387, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -9852,8 +9847,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -9958,7 +9952,7 @@ "tags": [ "functions" ], - "description": "Delete a function by its unique ID.", + "description": "", "responses": { "204": { "description": "No content" @@ -9966,12 +9960,12 @@ }, "x-appwrite": { "method": "delete", - "weight": 294, + "weight": 368, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10004,6 +9998,85 @@ ] } }, + "\/functions\/{functionId}\/deployment": { + "patch": { + "summary": "Update function's deployment", + "operationId": "functionsUpdateFunctionDeployment", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Function", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/function" + } + } + } + } + }, + "x-appwrite": { + "method": "updateFunctionDeployment", + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-function-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.", + "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": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + } + } + } + }, "\/functions\/{functionId}\/deployments": { "get": { "summary": "List deployments", @@ -10011,7 +10084,7 @@ "tags": [ "functions" ], - "description": "Get a list of all the function's code deployments. You can use the query params to filter your results.", + "description": "", "responses": { "200": { "description": "Deployments List", @@ -10026,12 +10099,12 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 295, + "weight": 374, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-deployments.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the function's code deployments. You can use the query params to filter your results.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10063,7 +10136,7 @@ }, { "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", + "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: buildSize, sourceSize, buildDuration, status, activate, type", "required": false, "schema": { "type": "array", @@ -10108,7 +10181,7 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 390, + "weight": 371, "cookies": false, "type": "upload", "deprecated": false, @@ -10181,6 +10254,90 @@ } } }, + "\/functions\/{functionId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "functionsCreateDuplicateDeployment", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "202": { + "description": "Deployment", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/deployment" + } + } + } + } + }, + "x-appwrite": { + "method": "createDuplicateDeployment", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/create-duplicate-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate 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.", + "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": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "x-example": "" + }, + "buildId": { + "type": "string", + "description": "Build unique ID.", + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + } + } + } + }, "\/functions\/{functionId}\/deployments\/template": { "post": { "summary": "Create template deployment", @@ -10203,7 +10360,7 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 391, + "weight": 376, "cookies": false, "type": "", "deprecated": false, @@ -10305,7 +10462,7 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 392, + "weight": 377, "cookies": false, "type": "", "deprecated": false, @@ -10385,7 +10542,7 @@ "tags": [ "functions" ], - "description": "Get a code deployment by its unique ID.", + "description": "", "responses": { "200": { "description": "Deployment", @@ -10400,12 +10557,12 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 296, + "weight": 372, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10453,7 +10610,7 @@ "tags": [ "functions" ], - "description": "Delete a code deployment by its unique ID.", + "description": "", "responses": { "204": { "description": "No content" @@ -10461,12 +10618,12 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 297, + "weight": 375, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a code deployment by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10509,85 +10666,6 @@ ] } }, - "\/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": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "buildId": { - "type": "string", - "description": "Build unique ID.", - "x-example": "" - } - } - } - } - } - } - } - }, "\/functions\/{functionId}\/deployments\/{deploymentId}\/download": { "get": { "summary": "Download deployment", @@ -10595,7 +10673,7 @@ "tags": [ "functions" ], - "description": "Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.", + "description": "", "responses": { "200": { "description": "File" @@ -10603,12 +10681,12 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 292, + "weight": 378, "cookies": false, "type": "location", "deprecated": false, "demo": "functions\/get-deployment-download.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment-download.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10629,6 +10707,93 @@ "JWT": [] } ], + "parameters": [ + { + "name": "functionId", + "description": "Function ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "schema": { + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": null, + "x-enum-keys": [], + "default": "source" + }, + "in": "query" + } + ] + } + }, + "\/functions\/{functionId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "functionsUpdateDeploymentStatus", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Deployment", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/deployment" + } + } + } + } + }, + "x-appwrite": { + "method": "updateDeploymentStatus", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-deployment-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", + "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", @@ -10660,7 +10825,7 @@ "tags": [ "functions" ], - "description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.", + "description": "", "responses": { "200": { "description": "Executions List", @@ -10675,12 +10840,12 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 301, + "weight": 383, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-executions.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the current user function execution logs. You can use the query params to filter your results.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10745,7 +10910,7 @@ "tags": [ "functions" ], - "description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", + "description": "", "responses": { "201": { "description": "Execution", @@ -10760,12 +10925,12 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 300, + "weight": 381, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/create-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterTrigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10859,7 +11024,7 @@ "tags": [ "functions" ], - "description": "Get a function execution log by its unique ID.", + "description": "", "responses": { "200": { "description": "Execution", @@ -10874,12 +11039,12 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 302, + "weight": 382, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function execution log by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10930,7 +11095,7 @@ "tags": [ "functions" ], - "description": "Delete a function execution by its unique ID.\n", + "description": "", "responses": { "204": { "description": "No content" @@ -10938,12 +11103,12 @@ }, "x-appwrite": { "method": "deleteExecution", - "weight": 303, + "weight": 384, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function execution by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10989,11 +11154,11 @@ "\/functions\/{functionId}\/usage": { "get": { "summary": "Get function usage", - "operationId": "functionsGetFunctionUsage", + "operationId": "functionsGetUsage", "tags": [ "functions" ], - "description": "Get usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", + "description": "", "responses": { "200": { "description": "UsageFunction", @@ -11007,13 +11172,13 @@ } }, "x-appwrite": { - "method": "getFunctionUsage", - "weight": 290, + "method": "getUsage", + "weight": 385, "cookies": false, "type": "", "deprecated": false, - "demo": "functions\/get-function-usage.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function-usage.md", + "demo": "functions\/get-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11074,7 +11239,7 @@ "tags": [ "functions" ], - "description": "Get a list of all variables of a specific function.", + "description": "", "responses": { "200": { "description": "Variables List", @@ -11089,12 +11254,12 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 305, + "weight": 389, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-variables.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all variables of a specific function.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11132,7 +11297,7 @@ "tags": [ "functions" ], - "description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.", + "description": "", "responses": { "201": { "description": "Variable", @@ -11147,12 +11312,12 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 304, + "weight": 387, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/create-variable.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new function environment variable. These variables can be accessed in the function at runtime as environment variables.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11215,6 +11380,234 @@ } } }, + "\/functions\/{functionId}\/variables\/{variableId}": { + "get": { + "summary": "Get variable", + "operationId": "functionsGetVariable", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Variable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variable" + } + } + } + } + }, + "x-appwrite": { + "method": "getVariable", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/get-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a variable by its unique ID.", + "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": "" + }, + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update variable", + "operationId": "functionsUpdateVariable", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Variable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variable" + } + } + } + } + }, + "x-appwrite": { + "method": "updateVariable", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate variable by its unique ID.", + "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": "" + }, + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "x-example": "" + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.", + "x-example": false + } + }, + "required": [ + "key" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete variable", + "operationId": "functionsDeleteVariable", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteVariable", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/delete-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a variable by its unique ID.", + "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": "" + }, + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, "\/graphql": { "post": { "summary": "GraphQL endpoint", @@ -11237,7 +11630,7 @@ }, "x-appwrite": { "method": "query", - "weight": 325, + "weight": 303, "cookies": false, "type": "graphql", "deprecated": false, @@ -11288,7 +11681,7 @@ }, "x-appwrite": { "method": "mutation", - "weight": 324, + "weight": 302, "cookies": false, "type": "graphql", "deprecated": false, @@ -11339,7 +11732,7 @@ }, "x-appwrite": { "method": "get", - "weight": 125, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -11387,7 +11780,7 @@ }, "x-appwrite": { "method": "getAntivirus", - "weight": 147, + "weight": 148, "cookies": false, "type": "", "deprecated": false, @@ -11435,7 +11828,7 @@ }, "x-appwrite": { "method": "getCache", - "weight": 128, + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -11483,7 +11876,7 @@ }, "x-appwrite": { "method": "getCertificate", - "weight": 133, + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -11542,7 +11935,7 @@ }, "x-appwrite": { "method": "getDB", - "weight": 127, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -11590,7 +11983,7 @@ }, "x-appwrite": { "method": "getPubSub", - "weight": 129, + "weight": 130, "cookies": false, "type": "", "deprecated": false, @@ -11638,7 +12031,7 @@ }, "x-appwrite": { "method": "getQueueBuilds", - "weight": 135, + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -11699,7 +12092,7 @@ }, "x-appwrite": { "method": "getQueueCertificates", - "weight": 134, + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -11760,7 +12153,7 @@ }, "x-appwrite": { "method": "getQueueDatabases", - "weight": 136, + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -11832,7 +12225,7 @@ }, "x-appwrite": { "method": "getQueueDeletes", - "weight": 137, + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -11893,7 +12286,7 @@ }, "x-appwrite": { "method": "getFailedJobs", - "weight": 148, + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -11981,7 +12374,7 @@ }, "x-appwrite": { "method": "getQueueFunctions", - "weight": 141, + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -12042,7 +12435,7 @@ }, "x-appwrite": { "method": "getQueueLogs", - "weight": 132, + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -12103,7 +12496,7 @@ }, "x-appwrite": { "method": "getQueueMails", - "weight": 138, + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -12164,7 +12557,7 @@ }, "x-appwrite": { "method": "getQueueMessaging", - "weight": 139, + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -12225,7 +12618,7 @@ }, "x-appwrite": { "method": "getQueueMigrations", - "weight": 140, + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -12286,7 +12679,7 @@ }, "x-appwrite": { "method": "getQueueStatsResources", - "weight": 142, + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -12347,7 +12740,7 @@ }, "x-appwrite": { "method": "getQueueUsage", - "weight": 143, + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -12408,7 +12801,7 @@ }, "x-appwrite": { "method": "getQueueStatsUsageDump", - "weight": 144, + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -12469,7 +12862,7 @@ }, "x-appwrite": { "method": "getQueueWebhooks", - "weight": 131, + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -12530,7 +12923,7 @@ }, "x-appwrite": { "method": "getStorage", - "weight": 146, + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -12578,7 +12971,7 @@ }, "x-appwrite": { "method": "getStorageLocal", - "weight": 145, + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -12626,7 +13019,7 @@ }, "x-appwrite": { "method": "getTime", - "weight": 130, + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -12674,7 +13067,7 @@ }, "x-appwrite": { "method": "get", - "weight": 117, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -12725,7 +13118,7 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 118, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -12776,7 +13169,7 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 122, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -12827,7 +13220,7 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 119, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -12878,7 +13271,7 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 120, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -12929,7 +13322,7 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 121, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -12980,7 +13373,7 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 123, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -13031,7 +13424,7 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 124, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -13082,7 +13475,7 @@ }, "x-appwrite": { "method": "listMessages", - "weight": 378, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -13157,7 +13550,7 @@ }, "x-appwrite": { "method": "createEmail", - "weight": 375, + "weight": 353, "cookies": false, "type": "", "deprecated": false, @@ -13300,7 +13693,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 382, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -13445,7 +13838,7 @@ }, "x-appwrite": { "method": "createPush", - "weight": 377, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -13618,7 +14011,7 @@ }, "x-appwrite": { "method": "updatePush", - "weight": 384, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -13795,7 +14188,7 @@ }, "x-appwrite": { "method": "createSms", - "weight": 376, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -13903,7 +14296,7 @@ }, "x-appwrite": { "method": "updateSms", - "weight": 383, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -14014,7 +14407,7 @@ }, "x-appwrite": { "method": "getMessage", - "weight": 381, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -14066,7 +14459,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 385, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -14127,7 +14520,7 @@ }, "x-appwrite": { "method": "listMessageLogs", - "weight": 379, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -14201,7 +14594,7 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 380, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -14275,7 +14668,7 @@ }, "x-appwrite": { "method": "listProviders", - "weight": 350, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -14350,7 +14743,7 @@ }, "x-appwrite": { "method": "createApnsProvider", - "weight": 349, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -14454,7 +14847,7 @@ }, "x-appwrite": { "method": "updateApnsProvider", - "weight": 362, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -14561,7 +14954,7 @@ }, "x-appwrite": { "method": "createFcmProvider", - "weight": 348, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -14645,7 +15038,7 @@ }, "x-appwrite": { "method": "updateFcmProvider", - "weight": 361, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -14732,7 +15125,7 @@ }, "x-appwrite": { "method": "createMailgunProvider", - "weight": 340, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -14846,7 +15239,7 @@ }, "x-appwrite": { "method": "updateMailgunProvider", - "weight": 353, + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -14963,7 +15356,7 @@ }, "x-appwrite": { "method": "createMsg91Provider", - "weight": 343, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -15057,7 +15450,7 @@ }, "x-appwrite": { "method": "updateMsg91Provider", - "weight": 356, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -15154,7 +15547,7 @@ }, "x-appwrite": { "method": "createSendgridProvider", - "weight": 341, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -15258,7 +15651,7 @@ }, "x-appwrite": { "method": "updateSendgridProvider", - "weight": 354, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -15365,7 +15758,7 @@ }, "x-appwrite": { "method": "createSmtpProvider", - "weight": 342, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -15507,7 +15900,7 @@ }, "x-appwrite": { "method": "updateSmtpProvider", - "weight": 355, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -15651,7 +16044,7 @@ }, "x-appwrite": { "method": "createTelesignProvider", - "weight": 344, + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -15745,7 +16138,7 @@ }, "x-appwrite": { "method": "updateTelesignProvider", - "weight": 357, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -15842,7 +16235,7 @@ }, "x-appwrite": { "method": "createTextmagicProvider", - "weight": 345, + "weight": 323, "cookies": false, "type": "", "deprecated": false, @@ -15936,7 +16329,7 @@ }, "x-appwrite": { "method": "updateTextmagicProvider", - "weight": 358, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -16033,7 +16426,7 @@ }, "x-appwrite": { "method": "createTwilioProvider", - "weight": 346, + "weight": 324, "cookies": false, "type": "", "deprecated": false, @@ -16127,7 +16520,7 @@ }, "x-appwrite": { "method": "updateTwilioProvider", - "weight": 359, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -16224,7 +16617,7 @@ }, "x-appwrite": { "method": "createVonageProvider", - "weight": 347, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -16318,7 +16711,7 @@ }, "x-appwrite": { "method": "updateVonageProvider", - "weight": 360, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -16415,7 +16808,7 @@ }, "x-appwrite": { "method": "getProvider", - "weight": 352, + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -16467,7 +16860,7 @@ }, "x-appwrite": { "method": "deleteProvider", - "weight": 363, + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -16528,7 +16921,7 @@ }, "x-appwrite": { "method": "listProviderLogs", - "weight": 351, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -16602,7 +16995,7 @@ }, "x-appwrite": { "method": "listSubscriberLogs", - "weight": 372, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -16676,7 +17069,7 @@ }, "x-appwrite": { "method": "listTopics", - "weight": 365, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -16749,7 +17142,7 @@ }, "x-appwrite": { "method": "createTopic", - "weight": 364, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -16831,7 +17224,7 @@ }, "x-appwrite": { "method": "getTopic", - "weight": 367, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -16890,7 +17283,7 @@ }, "x-appwrite": { "method": "updateTopic", - "weight": 368, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -16966,7 +17359,7 @@ }, "x-appwrite": { "method": "deleteTopic", - "weight": 369, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -17027,7 +17420,7 @@ }, "x-appwrite": { "method": "listTopicLogs", - "weight": 366, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -17101,7 +17494,7 @@ }, "x-appwrite": { "method": "listSubscribers", - "weight": 371, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -17184,7 +17577,7 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 370, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -17273,7 +17666,7 @@ }, "x-appwrite": { "method": "getSubscriber", - "weight": 373, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -17335,7 +17728,7 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 374, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -17409,7 +17802,7 @@ }, "x-appwrite": { "method": "list", - "weight": 332, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -17482,7 +17875,7 @@ }, "x-appwrite": { "method": "createAppwriteMigration", - "weight": 328, + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -17569,7 +17962,7 @@ }, "x-appwrite": { "method": "getAppwriteReport", - "weight": 334, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -17661,7 +18054,7 @@ }, "x-appwrite": { "method": "createFirebaseMigration", - "weight": 329, + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -17736,7 +18129,7 @@ }, "x-appwrite": { "method": "getFirebaseReport", - "weight": 335, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -17807,7 +18200,7 @@ }, "x-appwrite": { "method": "createNHostMigration", - "weight": 331, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -17917,7 +18310,7 @@ }, "x-appwrite": { "method": "getNHostReport", - "weight": 337, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -18049,7 +18442,7 @@ }, "x-appwrite": { "method": "createSupabaseMigration", - "weight": 330, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -18153,7 +18546,7 @@ }, "x-appwrite": { "method": "getSupabaseReport", - "weight": 336, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -18276,7 +18669,7 @@ }, "x-appwrite": { "method": "get", - "weight": 333, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -18333,7 +18726,7 @@ }, "x-appwrite": { "method": "retry", - "weight": 338, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -18383,7 +18776,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 339, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -18442,7 +18835,7 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 196, + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -18529,7 +18922,7 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 198, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -18574,7 +18967,7 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 197, + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -18651,7 +19044,7 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 199, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -18708,7 +19101,7 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 200, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -18787,7 +19180,7 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 201, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -18846,7 +19239,7 @@ }, "x-appwrite": { "method": "list", - "weight": 151, + "weight": 152, "cookies": false, "type": "", "deprecated": false, @@ -18917,7 +19310,7 @@ }, "x-appwrite": { "method": "create", - "weight": 150, + "weight": 151, "cookies": false, "type": "", "deprecated": false, @@ -19051,7 +19444,7 @@ }, "x-appwrite": { "method": "get", - "weight": 152, + "weight": 153, "cookies": false, "type": "", "deprecated": false, @@ -19108,7 +19501,7 @@ }, "x-appwrite": { "method": "update", - "weight": 153, + "weight": 154, "cookies": false, "type": "", "deprecated": false, @@ -19222,7 +19615,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 170, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -19281,7 +19674,7 @@ }, "x-appwrite": { "method": "updateApiStatus", - "weight": 157, + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -19372,7 +19765,7 @@ }, "x-appwrite": { "method": "updateApiStatusAll", - "weight": 158, + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -19450,7 +19843,7 @@ }, "x-appwrite": { "method": "updateAuthDuration", - "weight": 163, + "weight": 164, "cookies": false, "type": "", "deprecated": false, @@ -19528,7 +19921,7 @@ }, "x-appwrite": { "method": "updateAuthLimit", - "weight": 162, + "weight": 163, "cookies": false, "type": "", "deprecated": false, @@ -19606,7 +19999,7 @@ }, "x-appwrite": { "method": "updateAuthSessionsLimit", - "weight": 168, + "weight": 169, "cookies": false, "type": "", "deprecated": false, @@ -19684,7 +20077,7 @@ }, "x-appwrite": { "method": "updateMembershipsPrivacy", - "weight": 161, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -19774,7 +20167,7 @@ }, "x-appwrite": { "method": "updateMockNumbers", - "weight": 169, + "weight": 170, "cookies": false, "type": "", "deprecated": false, @@ -19855,7 +20248,7 @@ }, "x-appwrite": { "method": "updateAuthPasswordDictionary", - "weight": 166, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -19933,7 +20326,7 @@ }, "x-appwrite": { "method": "updateAuthPasswordHistory", - "weight": 165, + "weight": 166, "cookies": false, "type": "", "deprecated": false, @@ -20011,7 +20404,7 @@ }, "x-appwrite": { "method": "updatePersonalDataCheck", - "weight": 167, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -20089,7 +20482,7 @@ }, "x-appwrite": { "method": "updateSessionAlerts", - "weight": 160, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -20167,7 +20560,7 @@ }, "x-appwrite": { "method": "updateAuthStatus", - "weight": 164, + "weight": 165, "cookies": false, "type": "", "deprecated": false, @@ -20266,7 +20659,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 182, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -20352,7 +20745,7 @@ }, "x-appwrite": { "method": "listKeys", - "weight": 178, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -20409,7 +20802,7 @@ }, "x-appwrite": { "method": "createKey", - "weight": 177, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -20501,7 +20894,7 @@ }, "x-appwrite": { "method": "getKey", - "weight": 179, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -20568,7 +20961,7 @@ }, "x-appwrite": { "method": "updateKey", - "weight": 180, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -20661,7 +21054,7 @@ }, "x-appwrite": { "method": "deleteKey", - "weight": 181, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -20730,7 +21123,7 @@ }, "x-appwrite": { "method": "updateOAuth2", - "weight": 159, + "weight": 160, "cookies": false, "type": "", "deprecated": false, @@ -20866,7 +21259,7 @@ }, "x-appwrite": { "method": "listPlatforms", - "weight": 184, + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -20923,7 +21316,7 @@ }, "x-appwrite": { "method": "createPlatform", - "weight": 183, + "weight": 184, "cookies": false, "type": "", "deprecated": false, @@ -21041,7 +21434,7 @@ }, "x-appwrite": { "method": "getPlatform", - "weight": 185, + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -21108,7 +21501,7 @@ }, "x-appwrite": { "method": "updatePlatform", - "weight": 186, + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -21202,7 +21595,7 @@ }, "x-appwrite": { "method": "deletePlatform", - "weight": 187, + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -21271,7 +21664,7 @@ }, "x-appwrite": { "method": "updateServiceStatus", - "weight": 155, + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -21371,7 +21764,7 @@ }, "x-appwrite": { "method": "updateServiceStatusAll", - "weight": 156, + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -21449,7 +21842,7 @@ }, "x-appwrite": { "method": "updateSmtp", - "weight": 188, + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -21566,7 +21959,7 @@ }, "x-appwrite": { "method": "createSmtpTest", - "weight": 189, + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -21696,7 +22089,7 @@ }, "x-appwrite": { "method": "updateTeam", - "weight": 154, + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -21774,7 +22167,7 @@ }, "x-appwrite": { "method": "getEmailTemplate", - "weight": 191, + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -21997,7 +22390,7 @@ }, "x-appwrite": { "method": "updateEmailTemplate", - "weight": 193, + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -22260,7 +22653,7 @@ }, "x-appwrite": { "method": "deleteEmailTemplate", - "weight": 195, + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -22485,7 +22878,7 @@ }, "x-appwrite": { "method": "getSmsTemplate", - "weight": 190, + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -22705,7 +23098,7 @@ }, "x-appwrite": { "method": "updateSmsTemplate", - "weight": 192, + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -22944,7 +23337,7 @@ }, "x-appwrite": { "method": "deleteSmsTemplate", - "weight": 194, + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -23166,7 +23559,7 @@ }, "x-appwrite": { "method": "listWebhooks", - "weight": 172, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -23223,7 +23616,7 @@ }, "x-appwrite": { "method": "createWebhook", - "weight": 171, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -23337,7 +23730,7 @@ }, "x-appwrite": { "method": "getWebhook", - "weight": 173, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -23404,7 +23797,7 @@ }, "x-appwrite": { "method": "updateWebhook", - "weight": 174, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -23519,7 +23912,7 @@ }, "x-appwrite": { "method": "deleteWebhook", - "weight": 176, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -23588,7 +23981,7 @@ }, "x-appwrite": { "method": "updateWebhookSignature", - "weight": 175, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -23657,7 +24050,7 @@ }, "x-appwrite": { "method": "listRules", - "weight": 311, + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -23683,7 +24076,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, value, automation, url", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch", "required": false, "schema": { "type": "array", @@ -23730,7 +24123,7 @@ }, "x-appwrite": { "method": "createAPIRule", - "weight": 423, + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -23796,7 +24189,7 @@ }, "x-appwrite": { "method": "createFunctionRule", - "weight": 425, + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -23873,7 +24266,7 @@ }, "x-appwrite": { "method": "createRedirectRule", - "weight": 426, + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -23907,15 +24300,29 @@ "description": "Domain name.", "x-example": null }, - "target": { + "url": { "type": "string", - "description": "Target domain (hostname) of redirection", - "x-example": null + "description": "Target URL of redirection", + "x-example": "https:\/\/example.com" + }, + "statusCode": { + "type": "string", + "description": "Status code of redirection", + "x-example": "301", + "enum": [ + "301", + "302", + "307", + "308" + ], + "x-enum-name": null, + "x-enum-keys": [] } }, "required": [ "domain", - "target" + "url", + "statusCode" ] } } @@ -23945,7 +24352,7 @@ }, "x-appwrite": { "method": "createSiteRule", - "weight": 424, + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -24022,7 +24429,7 @@ }, "x-appwrite": { "method": "getRule", - "weight": 312, + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -24072,7 +24479,7 @@ }, "x-appwrite": { "method": "deleteRule", - "weight": 313, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -24131,7 +24538,7 @@ }, "x-appwrite": { "method": "updateRuleVerification", - "weight": 314, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -24190,7 +24597,7 @@ }, "x-appwrite": { "method": "list", - "weight": 395, + "weight": 396, "cookies": false, "type": "", "deprecated": false, @@ -24259,7 +24666,7 @@ }, "x-appwrite": { "method": "create", - "weight": 393, + "weight": 394, "cookies": false, "type": "", "deprecated": false, @@ -24407,8 +24814,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -24494,7 +24900,7 @@ }, "x-appwrite": { "method": "listFrameworks", - "weight": 398, + "weight": 399, "cookies": false, "type": "", "deprecated": false, @@ -24520,6 +24926,55 @@ ] } }, + "\/sites\/specifications": { + "get": { + "summary": "List specifications", + "operationId": "sitesListSpecifications", + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Specifications List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/specificationList" + } + } + } + } + }, + "x-appwrite": { + "method": "listSpecifications", + "weight": 422, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/list-specifications.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed site specifications for this instance.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.read", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, "\/sites\/templates": { "get": { "summary": "List templates", @@ -24767,7 +25222,7 @@ }, "x-appwrite": { "method": "get", - "weight": 394, + "weight": 395, "cookies": false, "type": "", "deprecated": false, @@ -24825,7 +25280,7 @@ }, "x-appwrite": { "method": "update", - "weight": 396, + "weight": 397, "cookies": false, "type": "", "deprecated": false, @@ -24980,8 +25435,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -25056,7 +25510,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 397, + "weight": 398, "cookies": false, "type": "", "deprecated": false, @@ -25094,6 +25548,85 @@ ] } }, + "\/sites\/{siteId}\/deployment": { + "patch": { + "summary": "Update site's deployment", + "operationId": "sitesUpdateSiteDeployment", + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Site", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/site" + } + } + } + } + }, + "x-appwrite": { + "method": "updateSiteDeployment", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/update-site-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + } + } + } + }, "\/sites\/{siteId}\/deployments": { "get": { "summary": "List deployments", @@ -25116,7 +25649,7 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 403, + "weight": 404, "cookies": false, "type": "", "deprecated": false, @@ -25153,7 +25686,7 @@ }, { "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", + "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: buildSize, sourceSize, buildDuration, status, activate, type", "required": false, "schema": { "type": "array", @@ -25198,7 +25731,7 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 399, + "weight": 400, "cookies": false, "type": "upload", "deprecated": false, @@ -25276,6 +25809,85 @@ } } }, + "\/sites\/{siteId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "sitesCreateDuplicateDeployment", + "tags": [ + "sites" + ], + "description": "", + "responses": { + "202": { + "description": "Deployment", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/deployment" + } + } + } + } + }, + "x-appwrite": { + "method": "createDuplicateDeployment", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/create-duplicate-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands 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.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + } + } + } + }, "\/sites\/{siteId}\/deployments\/template": { "post": { "summary": "Create deployment", @@ -25298,7 +25910,7 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 400, + "weight": 401, "cookies": false, "type": "", "deprecated": false, @@ -25400,7 +26012,7 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 401, + "weight": 402, "cookies": false, "type": "", "deprecated": false, @@ -25495,7 +26107,7 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 402, + "weight": 403, "cookies": false, "type": "", "deprecated": false, @@ -25542,74 +26154,6 @@ } ] }, - "patch": { - "summary": "Update deployment", - "operationId": "sitesUpdateDeployment", - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "Function", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/function" - } - } - } - } - }, - "x-appwrite": { - "method": "updateDeployment", - "weight": 404, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/update-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, "delete": { "summary": "Delete deployment", "operationId": "sitesDeleteDeployment", @@ -25624,7 +26168,7 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 405, + "weight": 406, "cookies": false, "type": "", "deprecated": false, @@ -25672,202 +26216,6 @@ ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/build": { - "post": { - "summary": "Rebuild deployment", - "operationId": "sitesCreateDeploymentBuild", - "tags": [ - "sites" - ], - "description": "", - "responses": { - "204": { - "description": "No content" - } - }, - "x-appwrite": { - "method": "createDeploymentBuild", - "weight": 408, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/create-deployment-build.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands 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.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "patch": { - "summary": "Cancel deployment", - "operationId": "sitesUpdateDeploymentBuild", - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "Build", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/build" - } - } - } - } - }, - "x-appwrite": { - "method": "updateDeploymentBuild", - "weight": 409, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/update-deployment-build.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/build\/download": { - "get": { - "summary": "Download build", - "operationId": "sitesGetDeploymentBuildDownload", - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "File" - } - }, - "x-appwrite": { - "method": "getDeploymentBuildDownload", - "weight": 407, - "cookies": false, - "type": "location", - "deprecated": false, - "demo": "sites\/get-deployment-build-download.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site build content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { "get": { "summary": "Download deployment", @@ -25883,7 +26231,7 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 406, + "weight": 407, "cookies": false, "type": "location", "deprecated": false, @@ -25909,6 +26257,93 @@ "JWT": [] } ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "schema": { + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [], + "default": "source" + }, + "in": "query" + } + ] + } + }, + "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "sitesUpdateDeploymentStatus", + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Deployment", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/deployment" + } + } + } + } + }, + "x-appwrite": { + "method": "updateDeploymentStatus", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/update-deployment-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], "parameters": [ { "name": "siteId", @@ -26624,7 +27059,7 @@ }, "x-appwrite": { "method": "listBuckets", - "weight": 203, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -26696,7 +27131,7 @@ }, "x-appwrite": { "method": "createBucket", - "weight": 202, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -26822,7 +27257,7 @@ }, "x-appwrite": { "method": "getBucket", - "weight": 204, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -26880,7 +27315,7 @@ }, "x-appwrite": { "method": "updateBucket", - "weight": 205, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -27003,7 +27438,7 @@ }, "x-appwrite": { "method": "deleteBucket", - "weight": 206, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -27063,7 +27498,7 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 208, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -27148,7 +27583,7 @@ }, "x-appwrite": { "method": "createFile", - "weight": 207, + "weight": 208, "cookies": false, "type": "upload", "deprecated": false, @@ -27245,7 +27680,7 @@ }, "x-appwrite": { "method": "getFile", - "weight": 209, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -27316,7 +27751,7 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 214, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -27404,7 +27839,7 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 215, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -27470,7 +27905,7 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 211, + "weight": 212, "cookies": false, "type": "location", "deprecated": false, @@ -27536,7 +27971,7 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 210, + "weight": 211, "cookies": false, "type": "location", "deprecated": false, @@ -27752,7 +28187,7 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 212, + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -27825,7 +28260,7 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 216, + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -27896,7 +28331,7 @@ }, "x-appwrite": { "method": "getBucketUsage", - "weight": 217, + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -27977,7 +28412,7 @@ }, "x-appwrite": { "method": "list", - "weight": 219, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -28052,7 +28487,7 @@ }, "x-appwrite": { "method": "create", - "weight": 218, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -28136,7 +28571,7 @@ }, "x-appwrite": { "method": "get", - "weight": 220, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -28197,7 +28632,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 222, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -28270,7 +28705,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 224, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -28333,7 +28768,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 231, + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -28405,7 +28840,7 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 226, + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -28490,7 +28925,7 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 225, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -28600,7 +29035,7 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 227, + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -28671,7 +29106,7 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 228, + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -28757,7 +29192,7 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 230, + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -28830,7 +29265,7 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 229, + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -28926,7 +29361,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 221, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -28985,7 +29420,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 223, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -29065,7 +29500,7 @@ }, "x-appwrite": { "method": "list", - "weight": 241, + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -29137,7 +29572,7 @@ }, "x-appwrite": { "method": "create", - "weight": 232, + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -29224,7 +29659,7 @@ }, "x-appwrite": { "method": "createArgon2User", - "weight": 235, + "weight": 236, "cookies": false, "type": "", "deprecated": false, @@ -29308,7 +29743,7 @@ }, "x-appwrite": { "method": "createBcryptUser", - "weight": 233, + "weight": 234, "cookies": false, "type": "", "deprecated": false, @@ -29392,7 +29827,7 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 249, + "weight": 250, "cookies": false, "type": "", "deprecated": false, @@ -29459,7 +29894,7 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 272, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -29519,7 +29954,7 @@ }, "x-appwrite": { "method": "createMD5User", - "weight": 234, + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -29603,7 +30038,7 @@ }, "x-appwrite": { "method": "createPHPassUser", - "weight": 237, + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -29687,7 +30122,7 @@ }, "x-appwrite": { "method": "createScryptUser", - "weight": 238, + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -29801,7 +30236,7 @@ }, "x-appwrite": { "method": "createScryptModifiedUser", - "weight": 239, + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -29903,7 +30338,7 @@ }, "x-appwrite": { "method": "createSHAUser", - "weight": 236, + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -30007,7 +30442,7 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 274, + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -30078,7 +30513,7 @@ }, "x-appwrite": { "method": "get", - "weight": 242, + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -30129,7 +30564,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 270, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -30189,7 +30624,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 255, + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -30268,7 +30703,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 273, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -30349,7 +30784,7 @@ }, "x-appwrite": { "method": "updateLabels", - "weight": 251, + "weight": 252, "cookies": false, "type": "", "deprecated": false, @@ -30431,7 +30866,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 247, + "weight": 248, "cookies": false, "type": "", "deprecated": false, @@ -30504,7 +30939,7 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 246, + "weight": 247, "cookies": false, "type": "", "deprecated": false, @@ -30564,7 +30999,7 @@ }, "x-appwrite": { "method": "updateMfa", - "weight": 260, + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -30636,7 +31071,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 265, + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -30711,7 +31146,7 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 261, + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -30771,7 +31206,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 262, + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -30829,7 +31264,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 264, + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -30887,7 +31322,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 263, + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -30947,7 +31382,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 253, + "weight": 254, "cookies": false, "type": "", "deprecated": false, @@ -31026,7 +31461,7 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 254, + "weight": 255, "cookies": false, "type": "", "deprecated": false, @@ -31105,7 +31540,7 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 256, + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -31184,7 +31619,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 243, + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -31242,7 +31677,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 258, + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -31321,7 +31756,7 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 245, + "weight": 246, "cookies": false, "type": "", "deprecated": false, @@ -31379,7 +31814,7 @@ }, "x-appwrite": { "method": "createSession", - "weight": 266, + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -31430,7 +31865,7 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 269, + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -31483,7 +31918,7 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 268, + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -31553,7 +31988,7 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 250, + "weight": 251, "cookies": false, "type": "", "deprecated": false, @@ -31632,7 +32067,7 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 248, + "weight": 249, "cookies": false, "type": "", "deprecated": false, @@ -31704,7 +32139,7 @@ }, "x-appwrite": { "method": "createTarget", - "weight": 240, + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -31813,7 +32248,7 @@ }, "x-appwrite": { "method": "getTarget", - "weight": 244, + "weight": 245, "cookies": false, "type": "", "deprecated": false, @@ -31882,7 +32317,7 @@ }, "x-appwrite": { "method": "updateTarget", - "weight": 259, + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -31970,7 +32405,7 @@ }, "x-appwrite": { "method": "deleteTarget", - "weight": 271, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -32041,7 +32476,7 @@ }, "x-appwrite": { "method": "createToken", - "weight": 267, + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -32122,7 +32557,7 @@ }, "x-appwrite": { "method": "updateEmailVerification", - "weight": 257, + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -32201,7 +32636,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 252, + "weight": 253, "cookies": false, "type": "", "deprecated": false, @@ -32258,6 +32693,101 @@ } } }, + "\/vcs\/github\/installations\/{installationId}\/detections": { + "post": { + "summary": "Create repository detection", + "operationId": "vcsCreateRepositoryDetection", + "tags": [ + "vcs" + ], + "description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", + "responses": { + "200": { + "description": "DetectionFramework", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/detectionFramework" + } + } + } + } + }, + "x-appwrite": { + "method": "createRepositoryDetection", + "weight": 279, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "vcs\/create-repository-detection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository-detection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "providerRepositoryId": { + "type": "string", + "description": "Repository Id", + "x-example": "" + }, + "type": { + "type": "string", + "description": "Detector type. Must be one of the following: runtime, framework", + "x-example": "runtime", + "enum": [ + "runtime", + "framework" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to Root Directory", + "x-example": "" + } + }, + "required": [ + "providerRepositoryId", + "type" + ] + } + } + } + } + } + }, "\/vcs\/github\/installations\/{installationId}\/providerRepositories": { "get": { "summary": "List repositories", @@ -32268,11 +32798,11 @@ "description": "Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.", "responses": { "200": { - "description": "Provider Repositories List", + "description": "Framework Provider Repositories List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/providerRepositoryList" + "$ref": "#\/components\/schemas\/providerRepositoryFrameworkList" } } } @@ -32280,7 +32810,7 @@ }, "x-appwrite": { "method": "listRepositories", - "weight": 279, + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -32314,6 +32844,22 @@ }, "in": "path" }, + { + "name": "type", + "description": "Detector type. Must be one of the following: runtime, framework", + "required": true, + "schema": { + "type": "string", + "x-example": "runtime", + "enum": [ + "runtime", + "framework" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "in": "query" + }, { "name": "search", "description": "Search term to filter your list results. Max length: 256 chars.", @@ -32348,7 +32894,7 @@ }, "x-appwrite": { "method": "createRepository", - "weight": 280, + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -32432,7 +32978,7 @@ }, "x-appwrite": { "method": "getRepository", - "weight": 281, + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -32501,7 +33047,7 @@ }, "x-appwrite": { "method": "listRepositoryBranches", - "weight": 282, + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -32570,7 +33116,7 @@ }, "x-appwrite": { "method": "getRepositoryContents", - "weight": 277, + "weight": 278, "cookies": false, "type": "", "deprecated": false, @@ -32628,91 +33174,6 @@ ] } }, - "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/detection": { - "post": { - "summary": "Detect runtime settings from source code", - "operationId": "vcsCreateRepositoryDetection", - "tags": [ - "vcs" - ], - "description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", - "responses": { - "200": { - "description": "Detection", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/detection" - } - } - } - } - }, - "x-appwrite": { - "method": "createRepositoryDetection", - "weight": 278, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "vcs\/create-repository-detection.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository-detection.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.write", - "platforms": [ - "console" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "installationId", - "description": "Installation Id", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "providerRepositoryId", - "description": "Repository Id", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "providerRootDirectory": { - "type": "string", - "description": "Path to Root Directory", - "x-example": "" - } - } - } - } - } - } - } - }, "\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}": { "patch": { "summary": "Authorize external deployment", @@ -32728,7 +33189,7 @@ }, "x-appwrite": { "method": "updateExternalDeployments", - "weight": 287, + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -32816,7 +33277,7 @@ }, "x-appwrite": { "method": "listInstallations", - "weight": 284, + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -32889,7 +33350,7 @@ }, "x-appwrite": { "method": "getInstallation", - "weight": 285, + "weight": 286, "cookies": false, "type": "", "deprecated": false, @@ -32939,7 +33400,7 @@ }, "x-appwrite": { "method": "deleteInstallation", - "weight": 286, + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -33513,28 +33974,52 @@ "installations" ] }, - "providerRepositoryList": { - "description": "Provider Repositories List", + "providerRepositoryFrameworkList": { + "description": "Framework Provider Repositories List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of providerRepositories documents that matched your query.", + "description": "Total number of frameworkProviderRepositories documents that matched your query.", "x-example": 5, "format": "int32" }, - "providerRepositories": { + "frameworkProviderRepositories": { "type": "array", - "description": "List of providerRepositories.", + "description": "List of frameworkProviderRepositories.", "items": { - "$ref": "#\/components\/schemas\/providerRepository" + "$ref": "#\/components\/schemas\/providerRepositoryFramework" }, "x-example": "" } }, "required": [ "total", - "providerRepositories" + "frameworkProviderRepositories" + ] + }, + "providerRepositoryRuntimeList": { + "description": "Runtime Provider Repositories List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of runtimeProviderRepositories documents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "runtimeProviderRepositories": { + "type": "array", + "description": "List of runtimeProviderRepositories.", + "items": { + "$ref": "#\/components\/schemas\/providerRepositoryRuntime" + }, + "x-example": "" + } + }, + "required": [ + "total", + "runtimeProviderRepositories" ] }, "branchList": { @@ -36505,10 +36990,15 @@ "description": "URL hosting a template demo.", "x-example": "https:\/\/nextjs-starter.appwrite.network\/" }, - "demoImage": { + "screenshotDark": { "type": "string", - "description": "File URL with preview screenshot.", - "x-example": "https:\/\/cloud.appwrite.io\/console\/images\/sites\/templates\/nextjs-starter.png" + "description": "File URL with preview screenshot in dark theme preference.", + "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png" + }, + "screenshotLight": { + "type": "string", + "description": "File URL with preview screenshot in light theme preference.", + "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png" }, "useCases": { "type": "array", @@ -36559,7 +37049,8 @@ "key", "name", "demoUrl", - "demoImage", + "screenshotDark", + "screenshotLight", "useCases", "frameworks", "vcsProvider", @@ -37080,11 +37571,6 @@ "description": "Is VCS (Version Control System) repository private?", "x-example": true }, - "runtime": { - "type": "string", - "description": "Auto-detected runtime suggestion. Empty if getting response of getRuntime().", - "x-example": "node" - }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", @@ -37097,22 +37583,165 @@ "organization", "provider", "private", - "runtime", "pushedAt" ] }, - "detection": { - "description": "Detection", + "providerRepositoryFramework": { + "description": "ProviderRepositoryFramework", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "VCS (Version Control System) repository ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "VCS (Version Control System) repository name.", + "x-example": "appwrite" + }, + "organization": { + "type": "string", + "description": "VCS (Version Control System) organization name", + "x-example": "appwrite" + }, + "provider": { + "type": "string", + "description": "VCS (Version Control System) provider name.", + "x-example": "github" + }, + "private": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository private?", + "x-example": true + }, + "pushedAt": { + "type": "string", + "description": "Last commit date in ISO 8601 format.", + "x-example": "datetime" + }, + "framework": { + "type": "string", + "description": "Auto-detected framework. Empty if type is not \"framework\".", + "x-example": "nextjs" + } + }, + "required": [ + "id", + "name", + "organization", + "provider", + "private", + "pushedAt", + "framework" + ] + }, + "providerRepositoryRuntime": { + "description": "ProviderRepositoryRuntime", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "VCS (Version Control System) repository ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "VCS (Version Control System) repository name.", + "x-example": "appwrite" + }, + "organization": { + "type": "string", + "description": "VCS (Version Control System) organization name", + "x-example": "appwrite" + }, + "provider": { + "type": "string", + "description": "VCS (Version Control System) provider name.", + "x-example": "github" + }, + "private": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository private?", + "x-example": true + }, + "pushedAt": { + "type": "string", + "description": "Last commit date in ISO 8601 format.", + "x-example": "datetime" + }, + "runtime": { + "type": "string", + "description": "Auto-detected runtime. Empty if type is not \"runtime\".", + "x-example": "node-22" + } + }, + "required": [ + "id", + "name", + "organization", + "provider", + "private", + "pushedAt", + "runtime" + ] + }, + "detectionFramework": { + "description": "DetectionFramework", + "type": "object", + "properties": { + "framework": { + "type": "string", + "description": "Framework", + "x-example": "nuxt" + }, + "installCommand": { + "type": "string", + "description": "Site Install Command", + "x-example": "npm install" + }, + "buildCommand": { + "type": "string", + "description": "Site Build Command", + "x-example": "npm run build" + }, + "outputDirectory": { + "type": "string", + "description": "Site Output Directory", + "x-example": "dist" + } + }, + "required": [ + "framework", + "installCommand", + "buildCommand", + "outputDirectory" + ] + }, + "detectionRuntime": { + "description": "DetectionRuntime", "type": "object", "properties": { "runtime": { "type": "string", "description": "Runtime", "x-example": "node" + }, + "entrypoint": { + "type": "string", + "description": "Function Entrypoint", + "x-example": "index.js" + }, + "commands": { + "type": "string", + "description": "Function install and build commands", + "x-example": "npm install && npm run build" } }, "required": [ - "runtime" + "runtime", + "entrypoint", + "commands" ] }, "vcsContent": { @@ -37341,7 +37970,7 @@ "description": "The entrypoint file to use to execute the deployment code.", "x-example": "index.js" }, - "size": { + "sourceSize": { "type": "integer", "description": "The code size in bytes.", "x-example": 128, @@ -37383,7 +38012,7 @@ "description": "The build logs.", "x-example": "Compiling source files..." }, - "buildTime": { + "buildDuration": { "type": "integer", "description": "The current build time in seconds.", "x-example": 128, @@ -37448,7 +38077,7 @@ "resourceId", "resourceType", "entrypoint", - "size", + "sourceSize", "buildSize", "buildId", "activate", @@ -37456,7 +38085,7 @@ "screenshotDark", "status", "buildLogs", - "buildTime", + "buildDuration", "providerRepositoryName", "providerRepositoryOwner", "providerRepositoryUrl", @@ -37600,70 +38229,6 @@ "duration" ] }, - "build": { - "description": "Build", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Build ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentId": { - "type": "string", - "description": "The deployment that created this build.", - "x-example": "5e5ea5c16897e" - }, - "status": { - "type": "string", - "description": "The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built", - "x-example": "ready" - }, - "stdout": { - "type": "string", - "description": "The stdout of the build.", - "x-example": "" - }, - "stderr": { - "type": "string", - "description": "The stderr of the build.", - "x-example": "" - }, - "startTime": { - "type": "string", - "description": "The deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "endTime": { - "type": "string", - "description": "The time the build was finished in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "duration": { - "type": "integer", - "description": "The build duration in seconds.", - "x-example": 0, - "format": "int32" - }, - "size": { - "type": "integer", - "description": "The code size in bytes.", - "x-example": 128, - "format": "int32" - } - }, - "required": [ - "$id", - "deploymentId", - "status", - "stdout", - "stderr", - "startTime", - "endTime", - "duration", - "size" - ] - }, "project": { "description": "Project", "type": "object", @@ -40001,15 +40566,41 @@ "description": "Action definition for the rule. Possible values are \"api\", \"deployment\", or \"redirect\"", "x-example": "deployment" }, - "value": { + "trigger": { "type": "string", - "description": "Detail specification for the type. If type is \"api\", this is empty. If type is \"redirect\", this is URL. If type is \"deployment\", this is deployment ID.", - "x-example": "67a9cf1a00150ee93abd" + "description": "Defines how the rule was created. Possible values are \"manual\" or \"deployment\"", + "x-example": "manual" }, - "automation": { + "redirectUrl": { "type": "string", - "description": "Action that results in a rule update. If VCS branch, value can be of syntax \"branch=[name]\"", - "x-example": "branch=dev" + "description": "URL to redirect to. Used if type is \"redirect\"", + "x-example": "https:\/\/appwrite.io\/docs" + }, + "redirectStatusCode": { + "type": "integer", + "description": "Status code to apply during redirect. Used if type is \"redirect\"", + "x-example": 301, + "format": "int32" + }, + "deploymentId": { + "type": "string", + "description": "ID of deployment. Used if type is \"deployment\"", + "x-example": "n3u9feiwmf" + }, + "deploymentResourceType": { + "type": "string", + "description": "Type of deployment. Possible values are \"function\", \"site\". Used if rule's type is \"deployment\".", + "x-example": "function" + }, + "deploymentResourceId": { + "type": "string", + "description": "ID deployment's resource. Used if type is \"deployment\"", + "x-example": "n3u9feiwmf" + }, + "deploymentVcsProviderBranch": { + "type": "string", + "description": "Name of Git branch that updates rule. Used if type is \"deployment\"", + "x-example": "function" }, "status": { "type": "string", @@ -40033,8 +40624,13 @@ "$updatedAt", "domain", "type", - "value", - "automation", + "trigger", + "redirectUrl", + "redirectStatusCode", + "deploymentId", + "deploymentResourceType", + "deploymentResourceId", + "deploymentVcsProviderBranch", "status", "logs", "renewAt" diff --git a/app/config/specs/open-api3-latest-server.json b/app/config/specs/open-api3-latest-server.json index 9bc803d777..daa7bd1433 100644 --- a/app/config/specs/open-api3-latest-server.json +++ b/app/config/specs/open-api3-latest-server.json @@ -43,7 +43,7 @@ }, "x-appwrite": { "method": "get", - "weight": 9, + "weight": 10, "cookies": false, "type": "", "deprecated": false, @@ -92,7 +92,7 @@ }, "x-appwrite": { "method": "create", - "weight": 8, + "weight": 9, "cookies": false, "type": "", "deprecated": false, @@ -176,7 +176,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 34, + "weight": 35, "cookies": false, "type": "", "deprecated": false, @@ -252,7 +252,7 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 57, + "weight": 58, "cookies": false, "type": "", "deprecated": false, @@ -311,7 +311,7 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 58, + "weight": 59, "cookies": false, "type": "", "deprecated": false, @@ -374,7 +374,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 29, + "weight": 30, "cookies": false, "type": "", "deprecated": false, @@ -422,7 +422,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 31, + "weight": 32, "cookies": false, "type": "", "deprecated": false, @@ -488,7 +488,7 @@ }, "x-appwrite": { "method": "updateMFA", - "weight": 44, + "weight": 45, "cookies": false, "type": "", "deprecated": false, @@ -558,7 +558,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", - "weight": 46, + "weight": 47, "cookies": false, "type": "", "deprecated": false, @@ -624,7 +624,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", - "weight": 47, + "weight": 48, "cookies": false, "type": "", "deprecated": false, @@ -702,7 +702,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 51, + "weight": 52, "cookies": false, "type": "", "deprecated": false, @@ -770,7 +770,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", - "weight": 52, + "weight": 53, "cookies": false, "type": "", "deprecated": false, @@ -843,7 +843,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", - "weight": 53, + "weight": 54, "cookies": false, "type": "", "deprecated": false, @@ -919,7 +919,7 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 45, + "weight": 46, "cookies": false, "type": "", "deprecated": false, @@ -970,7 +970,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 50, + "weight": 51, "cookies": false, "type": "", "deprecated": false, @@ -1019,7 +1019,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 48, + "weight": 49, "cookies": false, "type": "", "deprecated": false, @@ -1068,7 +1068,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 49, + "weight": 50, "cookies": false, "type": "", "deprecated": false, @@ -1119,7 +1119,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 32, + "weight": 33, "cookies": false, "type": "", "deprecated": false, @@ -1189,7 +1189,7 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 33, + "weight": 34, "cookies": false, "type": "", "deprecated": false, @@ -1264,7 +1264,7 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 35, + "weight": 36, "cookies": false, "type": "", "deprecated": false, @@ -1340,7 +1340,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 30, + "weight": 31, "cookies": false, "type": "", "deprecated": false, @@ -1389,7 +1389,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 36, + "weight": 37, "cookies": false, "type": "", "deprecated": false, @@ -1459,7 +1459,7 @@ }, "x-appwrite": { "method": "createRecovery", - "weight": 38, + "weight": 39, "cookies": false, "type": "", "deprecated": false, @@ -1536,7 +1536,7 @@ }, "x-appwrite": { "method": "updateRecovery", - "weight": 39, + "weight": 40, "cookies": false, "type": "", "deprecated": false, @@ -1618,7 +1618,7 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 11, + "weight": 12, "cookies": false, "type": "", "deprecated": false, @@ -1660,7 +1660,7 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 12, + "weight": 13, "cookies": false, "type": "", "deprecated": false, @@ -1711,7 +1711,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", - "weight": 17, + "weight": 18, "cookies": false, "type": "", "deprecated": false, @@ -1759,7 +1759,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", - "weight": 16, + "weight": 17, "cookies": false, "type": "", "deprecated": false, @@ -1832,7 +1832,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", - "weight": 26, + "weight": 27, "cookies": false, "type": "", "deprecated": true, @@ -1905,7 +1905,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", - "weight": 27, + "weight": 28, "cookies": false, "type": "", "deprecated": true, @@ -1978,7 +1978,7 @@ }, "x-appwrite": { "method": "createSession", - "weight": 18, + "weight": 19, "cookies": false, "type": "", "deprecated": false, @@ -2051,7 +2051,7 @@ }, "x-appwrite": { "method": "getSession", - "weight": 13, + "weight": 14, "cookies": false, "type": "", "deprecated": false, @@ -2112,7 +2112,7 @@ }, "x-appwrite": { "method": "updateSession", - "weight": 15, + "weight": 16, "cookies": false, "type": "", "deprecated": false, @@ -2166,7 +2166,7 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 14, + "weight": 15, "cookies": false, "type": "", "deprecated": false, @@ -2229,7 +2229,7 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 37, + "weight": 38, "cookies": false, "type": "", "deprecated": false, @@ -2280,7 +2280,7 @@ }, "x-appwrite": { "method": "createEmailToken", - "weight": 25, + "weight": 26, "cookies": false, "type": "", "deprecated": false, @@ -2358,7 +2358,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", - "weight": 24, + "weight": 25, "cookies": false, "type": "", "deprecated": false, @@ -2437,7 +2437,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", - "weight": 23, + "weight": 24, "cookies": false, "type": "webAuth", "deprecated": false, @@ -2577,7 +2577,7 @@ }, "x-appwrite": { "method": "createPhoneToken", - "weight": 28, + "weight": 29, "cookies": false, "type": "", "deprecated": false, @@ -2653,7 +2653,7 @@ }, "x-appwrite": { "method": "createVerification", - "weight": 40, + "weight": 41, "cookies": false, "type": "", "deprecated": false, @@ -2721,7 +2721,7 @@ }, "x-appwrite": { "method": "updateVerification", - "weight": 41, + "weight": 42, "cookies": false, "type": "", "deprecated": false, @@ -2797,7 +2797,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", - "weight": 42, + "weight": 43, "cookies": false, "type": "", "deprecated": false, @@ -2849,7 +2849,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 43, + "weight": 44, "cookies": false, "type": "", "deprecated": false, @@ -2918,7 +2918,7 @@ }, "x-appwrite": { "method": "getBrowser", - "weight": 60, + "weight": 61, "cookies": false, "type": "location", "deprecated": false, @@ -3045,7 +3045,7 @@ }, "x-appwrite": { "method": "getCreditCard", - "weight": 59, + "weight": 60, "cookies": false, "type": "location", "deprecated": false, @@ -3178,7 +3178,7 @@ }, "x-appwrite": { "method": "getFavicon", - "weight": 63, + "weight": 64, "cookies": false, "type": "location", "deprecated": false, @@ -3237,7 +3237,7 @@ }, "x-appwrite": { "method": "getFlag", - "weight": 61, + "weight": 62, "cookies": false, "type": "location", "deprecated": false, @@ -3726,7 +3726,7 @@ }, "x-appwrite": { "method": "getImage", - "weight": 62, + "weight": 63, "cookies": false, "type": "location", "deprecated": false, @@ -3809,7 +3809,7 @@ }, "x-appwrite": { "method": "getInitials", - "weight": 65, + "weight": 66, "cookies": false, "type": "location", "deprecated": false, @@ -3902,7 +3902,7 @@ }, "x-appwrite": { "method": "getQR", - "weight": 64, + "weight": 65, "cookies": false, "type": "location", "deprecated": false, @@ -4002,7 +4002,7 @@ }, "x-appwrite": { "method": "list", - "weight": 70, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -4075,7 +4075,7 @@ }, "x-appwrite": { "method": "create", - "weight": 69, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -4154,7 +4154,7 @@ }, "x-appwrite": { "method": "get", - "weight": 71, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -4213,7 +4213,7 @@ }, "x-appwrite": { "method": "update", - "weight": 73, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -4289,7 +4289,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 74, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -4350,7 +4350,7 @@ }, "x-appwrite": { "method": "listCollections", - "weight": 76, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -4433,7 +4433,7 @@ }, "x-appwrite": { "method": "createCollection", - "weight": 75, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -4537,7 +4537,7 @@ }, "x-appwrite": { "method": "getCollection", - "weight": 77, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -4606,7 +4606,7 @@ }, "x-appwrite": { "method": "updateCollection", - "weight": 79, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -4705,7 +4705,7 @@ }, "x-appwrite": { "method": "deleteCollection", - "weight": 80, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -4776,7 +4776,7 @@ }, "x-appwrite": { "method": "listAttributes", - "weight": 91, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -4860,7 +4860,7 @@ }, "x-appwrite": { "method": "createBooleanAttribute", - "weight": 88, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -4966,7 +4966,7 @@ }, "x-appwrite": { "method": "updateBooleanAttribute", - "weight": 100, + "weight": 101, "cookies": false, "type": "", "deprecated": false, @@ -5077,7 +5077,7 @@ }, "x-appwrite": { "method": "createDatetimeAttribute", - "weight": 89, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -5183,7 +5183,7 @@ }, "x-appwrite": { "method": "updateDatetimeAttribute", - "weight": 101, + "weight": 102, "cookies": false, "type": "", "deprecated": false, @@ -5294,7 +5294,7 @@ }, "x-appwrite": { "method": "createEmailAttribute", - "weight": 82, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -5400,7 +5400,7 @@ }, "x-appwrite": { "method": "updateEmailAttribute", - "weight": 94, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -5511,7 +5511,7 @@ }, "x-appwrite": { "method": "createEnumAttribute", - "weight": 83, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -5626,7 +5626,7 @@ }, "x-appwrite": { "method": "updateEnumAttribute", - "weight": 95, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -5746,7 +5746,7 @@ }, "x-appwrite": { "method": "createFloatAttribute", - "weight": 87, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -5862,7 +5862,7 @@ }, "x-appwrite": { "method": "updateFloatAttribute", - "weight": 99, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -5985,7 +5985,7 @@ }, "x-appwrite": { "method": "createIntegerAttribute", - "weight": 86, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -6101,7 +6101,7 @@ }, "x-appwrite": { "method": "updateIntegerAttribute", - "weight": 98, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -6224,7 +6224,7 @@ }, "x-appwrite": { "method": "createIpAttribute", - "weight": 84, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -6330,7 +6330,7 @@ }, "x-appwrite": { "method": "updateIpAttribute", - "weight": 96, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -6441,7 +6441,7 @@ }, "x-appwrite": { "method": "createRelationshipAttribute", - "weight": 90, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -6572,7 +6572,7 @@ }, "x-appwrite": { "method": "createStringAttribute", - "weight": 81, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -6689,7 +6689,7 @@ }, "x-appwrite": { "method": "updateStringAttribute", - "weight": 93, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -6805,7 +6805,7 @@ }, "x-appwrite": { "method": "createUrlAttribute", - "weight": 85, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -6911,7 +6911,7 @@ }, "x-appwrite": { "method": "updateUrlAttribute", - "weight": 97, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -7053,7 +7053,7 @@ }, "x-appwrite": { "method": "getAttribute", - "weight": 92, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -7124,7 +7124,7 @@ }, "x-appwrite": { "method": "deleteAttribute", - "weight": 103, + "weight": 104, "cookies": false, "type": "", "deprecated": false, @@ -7204,7 +7204,7 @@ }, "x-appwrite": { "method": "updateRelationshipAttribute", - "weight": 102, + "weight": 103, "cookies": false, "type": "", "deprecated": false, @@ -7312,7 +7312,7 @@ }, "x-appwrite": { "method": "listDocuments", - "weight": 109, + "weight": 110, "cookies": false, "type": "", "deprecated": false, @@ -7398,7 +7398,7 @@ }, "x-appwrite": { "method": "createDocument", - "weight": 108, + "weight": 109, "cookies": false, "type": "", "deprecated": false, @@ -7506,7 +7506,7 @@ }, "x-appwrite": { "method": "getDocument", - "weight": 110, + "weight": 111, "cookies": false, "type": "", "deprecated": false, @@ -7602,7 +7602,7 @@ }, "x-appwrite": { "method": "updateDocument", - "weight": 112, + "weight": 113, "cookies": false, "type": "", "deprecated": false, @@ -7702,7 +7702,7 @@ }, "x-appwrite": { "method": "deleteDocument", - "weight": 113, + "weight": 114, "cookies": false, "type": "", "deprecated": false, @@ -7787,7 +7787,7 @@ }, "x-appwrite": { "method": "listIndexes", - "weight": 105, + "weight": 106, "cookies": false, "type": "", "deprecated": false, @@ -7869,7 +7869,7 @@ }, "x-appwrite": { "method": "createIndex", - "weight": 104, + "weight": 105, "cookies": false, "type": "", "deprecated": false, @@ -7989,7 +7989,7 @@ }, "x-appwrite": { "method": "getIndex", - "weight": 106, + "weight": 107, "cookies": false, "type": "", "deprecated": false, @@ -8060,7 +8060,7 @@ }, "x-appwrite": { "method": "deleteIndex", - "weight": 107, + "weight": 108, "cookies": false, "type": "", "deprecated": false, @@ -8140,7 +8140,7 @@ }, "x-appwrite": { "method": "list", - "weight": 388, + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -8213,7 +8213,7 @@ }, "x-appwrite": { "method": "create", - "weight": 386, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -8319,8 +8319,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -8443,7 +8442,7 @@ }, "x-appwrite": { "method": "listRuntimes", - "weight": 389, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -8472,12 +8471,12 @@ }, "\/functions\/specifications": { "get": { - "summary": "List available function runtime specifications", + "summary": "List specifications", "operationId": "functionsListSpecifications", "tags": [ "functions" ], - "description": "List allowed function specifications for this instance.\n", + "description": "", "responses": { "200": { "description": "Specifications List", @@ -8492,12 +8491,12 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 288, + "weight": 370, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-specifications.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-specifications.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed function specifications for this instance.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8527,7 +8526,7 @@ "tags": [ "functions" ], - "description": "Get a function by its unique ID.", + "description": "", "responses": { "200": { "description": "Function", @@ -8542,12 +8541,12 @@ }, "x-appwrite": { "method": "get", - "weight": 289, + "weight": 365, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8601,7 +8600,7 @@ }, "x-appwrite": { "method": "update", - "weight": 387, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -8714,8 +8713,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -8820,7 +8818,7 @@ "tags": [ "functions" ], - "description": "Delete a function by its unique ID.", + "description": "", "responses": { "204": { "description": "No content" @@ -8828,12 +8826,12 @@ }, "x-appwrite": { "method": "delete", - "weight": 294, + "weight": 368, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8867,6 +8865,86 @@ ] } }, + "\/functions\/{functionId}\/deployment": { + "patch": { + "summary": "Update function's deployment", + "operationId": "functionsUpdateFunctionDeployment", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Function", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/function" + } + } + } + } + }, + "x-appwrite": { + "method": "updateFunctionDeployment", + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-function-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.", + "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": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + } + } + } + }, "\/functions\/{functionId}\/deployments": { "get": { "summary": "List deployments", @@ -8874,7 +8952,7 @@ "tags": [ "functions" ], - "description": "Get a list of all the function's code deployments. You can use the query params to filter your results.", + "description": "", "responses": { "200": { "description": "Deployments List", @@ -8889,12 +8967,12 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 295, + "weight": 374, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-deployments.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the function's code deployments. You can use the query params to filter your results.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8927,7 +9005,7 @@ }, { "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", + "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: buildSize, sourceSize, buildDuration, status, activate, type", "required": false, "schema": { "type": "array", @@ -8972,7 +9050,7 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 390, + "weight": 371, "cookies": false, "type": "upload", "deprecated": false, @@ -9046,6 +9124,91 @@ } } }, + "\/functions\/{functionId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "functionsCreateDuplicateDeployment", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "202": { + "description": "Deployment", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/deployment" + } + } + } + } + }, + "x-appwrite": { + "method": "createDuplicateDeployment", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/create-duplicate-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate 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.", + "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": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "x-example": "" + }, + "buildId": { + "type": "string", + "description": "Build unique ID.", + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + } + } + } + }, "\/functions\/{functionId}\/deployments\/template": { "post": { "summary": "Create template deployment", @@ -9068,7 +9231,7 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 391, + "weight": 376, "cookies": false, "type": "", "deprecated": false, @@ -9171,7 +9334,7 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 392, + "weight": 377, "cookies": false, "type": "", "deprecated": false, @@ -9252,7 +9415,7 @@ "tags": [ "functions" ], - "description": "Get a code deployment by its unique ID.", + "description": "", "responses": { "200": { "description": "Deployment", @@ -9267,12 +9430,12 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 296, + "weight": 372, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9321,7 +9484,7 @@ "tags": [ "functions" ], - "description": "Delete a code deployment by its unique ID.", + "description": "", "responses": { "204": { "description": "No content" @@ -9329,12 +9492,12 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 297, + "weight": 375, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a code deployment by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9378,86 +9541,6 @@ ] } }, - "\/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": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "buildId": { - "type": "string", - "description": "Build unique ID.", - "x-example": "" - } - } - } - } - } - } - } - }, "\/functions\/{functionId}\/deployments\/{deploymentId}\/download": { "get": { "summary": "Download deployment", @@ -9465,7 +9548,7 @@ "tags": [ "functions" ], - "description": "Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.", + "description": "", "responses": { "200": { "description": "File" @@ -9473,12 +9556,12 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 292, + "weight": 378, "cookies": false, "type": "location", "deprecated": false, "demo": "functions\/get-deployment-download.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment-download.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9500,6 +9583,94 @@ "JWT": [] } ], + "parameters": [ + { + "name": "functionId", + "description": "Function ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "schema": { + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": null, + "x-enum-keys": [], + "default": "source" + }, + "in": "query" + } + ] + } + }, + "\/functions\/{functionId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "functionsUpdateDeploymentStatus", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Deployment", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/deployment" + } + } + } + } + }, + "x-appwrite": { + "method": "updateDeploymentStatus", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-deployment-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and 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", @@ -9531,7 +9702,7 @@ "tags": [ "functions" ], - "description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.", + "description": "", "responses": { "200": { "description": "Executions List", @@ -9546,12 +9717,12 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 301, + "weight": 383, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-executions.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the current user function execution logs. You can use the query params to filter your results.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9618,7 +9789,7 @@ "tags": [ "functions" ], - "description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", + "description": "", "responses": { "201": { "description": "Execution", @@ -9633,12 +9804,12 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 300, + "weight": 381, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/create-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterTrigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9734,7 +9905,7 @@ "tags": [ "functions" ], - "description": "Get a function execution log by its unique ID.", + "description": "", "responses": { "200": { "description": "Execution", @@ -9749,12 +9920,12 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 302, + "weight": 382, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function execution log by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9807,7 +9978,7 @@ "tags": [ "functions" ], - "description": "Delete a function execution by its unique ID.\n", + "description": "", "responses": { "204": { "description": "No content" @@ -9815,12 +9986,12 @@ }, "x-appwrite": { "method": "deleteExecution", - "weight": 303, + "weight": 384, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function execution by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9871,7 +10042,7 @@ "tags": [ "functions" ], - "description": "Get a list of all variables of a specific function.", + "description": "", "responses": { "200": { "description": "Variables List", @@ -9886,12 +10057,12 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 305, + "weight": 389, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-variables.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all variables of a specific function.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9930,7 +10101,7 @@ "tags": [ "functions" ], - "description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.", + "description": "", "responses": { "201": { "description": "Variable", @@ -9945,12 +10116,12 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 304, + "weight": 387, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/create-variable.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new function environment variable. These variables can be accessed in the function at runtime as environment variables.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10014,6 +10185,237 @@ } } }, + "\/functions\/{functionId}\/variables\/{variableId}": { + "get": { + "summary": "Get variable", + "operationId": "functionsGetVariable", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Variable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variable" + } + } + } + } + }, + "x-appwrite": { + "method": "getVariable", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/get-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a variable by its unique ID.", + "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": "" + }, + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update variable", + "operationId": "functionsUpdateVariable", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Variable", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/variable" + } + } + } + } + }, + "x-appwrite": { + "method": "updateVariable", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate variable by its unique ID.", + "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": "" + }, + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "x-example": "" + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.", + "x-example": false + } + }, + "required": [ + "key" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete variable", + "operationId": "functionsDeleteVariable", + "tags": [ + "functions" + ], + "description": "", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteVariable", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/delete-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a variable by its unique ID.", + "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": "" + }, + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, "\/graphql": { "post": { "summary": "GraphQL endpoint", @@ -10036,7 +10438,7 @@ }, "x-appwrite": { "method": "query", - "weight": 325, + "weight": 303, "cookies": false, "type": "graphql", "deprecated": false, @@ -10089,7 +10491,7 @@ }, "x-appwrite": { "method": "mutation", - "weight": 324, + "weight": 302, "cookies": false, "type": "graphql", "deprecated": false, @@ -10142,7 +10544,7 @@ }, "x-appwrite": { "method": "get", - "weight": 125, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -10191,7 +10593,7 @@ }, "x-appwrite": { "method": "getAntivirus", - "weight": 147, + "weight": 148, "cookies": false, "type": "", "deprecated": false, @@ -10240,7 +10642,7 @@ }, "x-appwrite": { "method": "getCache", - "weight": 128, + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -10289,7 +10691,7 @@ }, "x-appwrite": { "method": "getCertificate", - "weight": 133, + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -10349,7 +10751,7 @@ }, "x-appwrite": { "method": "getDB", - "weight": 127, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -10398,7 +10800,7 @@ }, "x-appwrite": { "method": "getPubSub", - "weight": 129, + "weight": 130, "cookies": false, "type": "", "deprecated": false, @@ -10447,7 +10849,7 @@ }, "x-appwrite": { "method": "getQueueBuilds", - "weight": 135, + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -10509,7 +10911,7 @@ }, "x-appwrite": { "method": "getQueueCertificates", - "weight": 134, + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -10571,7 +10973,7 @@ }, "x-appwrite": { "method": "getQueueDatabases", - "weight": 136, + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -10644,7 +11046,7 @@ }, "x-appwrite": { "method": "getQueueDeletes", - "weight": 137, + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -10706,7 +11108,7 @@ }, "x-appwrite": { "method": "getFailedJobs", - "weight": 148, + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -10795,7 +11197,7 @@ }, "x-appwrite": { "method": "getQueueFunctions", - "weight": 141, + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -10857,7 +11259,7 @@ }, "x-appwrite": { "method": "getQueueLogs", - "weight": 132, + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -10919,7 +11321,7 @@ }, "x-appwrite": { "method": "getQueueMails", - "weight": 138, + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -10981,7 +11383,7 @@ }, "x-appwrite": { "method": "getQueueMessaging", - "weight": 139, + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -11043,7 +11445,7 @@ }, "x-appwrite": { "method": "getQueueMigrations", - "weight": 140, + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -11105,7 +11507,7 @@ }, "x-appwrite": { "method": "getQueueStatsResources", - "weight": 142, + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -11167,7 +11569,7 @@ }, "x-appwrite": { "method": "getQueueUsage", - "weight": 143, + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -11229,7 +11631,7 @@ }, "x-appwrite": { "method": "getQueueStatsUsageDump", - "weight": 144, + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -11291,7 +11693,7 @@ }, "x-appwrite": { "method": "getQueueWebhooks", - "weight": 131, + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -11353,7 +11755,7 @@ }, "x-appwrite": { "method": "getStorage", - "weight": 146, + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -11402,7 +11804,7 @@ }, "x-appwrite": { "method": "getStorageLocal", - "weight": 145, + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -11451,7 +11853,7 @@ }, "x-appwrite": { "method": "getTime", - "weight": 130, + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -11500,7 +11902,7 @@ }, "x-appwrite": { "method": "get", - "weight": 117, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -11553,7 +11955,7 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 118, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -11606,7 +12008,7 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 122, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -11659,7 +12061,7 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 119, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -11712,7 +12114,7 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 120, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -11765,7 +12167,7 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 121, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -11818,7 +12220,7 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 123, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -11871,7 +12273,7 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 124, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -11924,7 +12326,7 @@ }, "x-appwrite": { "method": "listMessages", - "weight": 378, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -12000,7 +12402,7 @@ }, "x-appwrite": { "method": "createEmail", - "weight": 375, + "weight": 353, "cookies": false, "type": "", "deprecated": false, @@ -12144,7 +12546,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 382, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -12290,7 +12692,7 @@ }, "x-appwrite": { "method": "createPush", - "weight": 377, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -12464,7 +12866,7 @@ }, "x-appwrite": { "method": "updatePush", - "weight": 384, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -12642,7 +13044,7 @@ }, "x-appwrite": { "method": "createSms", - "weight": 376, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -12751,7 +13153,7 @@ }, "x-appwrite": { "method": "updateSms", - "weight": 383, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -12863,7 +13265,7 @@ }, "x-appwrite": { "method": "getMessage", - "weight": 381, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -12916,7 +13318,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 385, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -12978,7 +13380,7 @@ }, "x-appwrite": { "method": "listMessageLogs", - "weight": 379, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -13053,7 +13455,7 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 380, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -13128,7 +13530,7 @@ }, "x-appwrite": { "method": "listProviders", - "weight": 350, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -13204,7 +13606,7 @@ }, "x-appwrite": { "method": "createApnsProvider", - "weight": 349, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -13309,7 +13711,7 @@ }, "x-appwrite": { "method": "updateApnsProvider", - "weight": 362, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -13417,7 +13819,7 @@ }, "x-appwrite": { "method": "createFcmProvider", - "weight": 348, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -13502,7 +13904,7 @@ }, "x-appwrite": { "method": "updateFcmProvider", - "weight": 361, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -13590,7 +13992,7 @@ }, "x-appwrite": { "method": "createMailgunProvider", - "weight": 340, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -13705,7 +14107,7 @@ }, "x-appwrite": { "method": "updateMailgunProvider", - "weight": 353, + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -13823,7 +14225,7 @@ }, "x-appwrite": { "method": "createMsg91Provider", - "weight": 343, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -13918,7 +14320,7 @@ }, "x-appwrite": { "method": "updateMsg91Provider", - "weight": 356, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -14016,7 +14418,7 @@ }, "x-appwrite": { "method": "createSendgridProvider", - "weight": 341, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -14121,7 +14523,7 @@ }, "x-appwrite": { "method": "updateSendgridProvider", - "weight": 354, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -14229,7 +14631,7 @@ }, "x-appwrite": { "method": "createSmtpProvider", - "weight": 342, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -14372,7 +14774,7 @@ }, "x-appwrite": { "method": "updateSmtpProvider", - "weight": 355, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -14517,7 +14919,7 @@ }, "x-appwrite": { "method": "createTelesignProvider", - "weight": 344, + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -14612,7 +15014,7 @@ }, "x-appwrite": { "method": "updateTelesignProvider", - "weight": 357, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -14710,7 +15112,7 @@ }, "x-appwrite": { "method": "createTextmagicProvider", - "weight": 345, + "weight": 323, "cookies": false, "type": "", "deprecated": false, @@ -14805,7 +15207,7 @@ }, "x-appwrite": { "method": "updateTextmagicProvider", - "weight": 358, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -14903,7 +15305,7 @@ }, "x-appwrite": { "method": "createTwilioProvider", - "weight": 346, + "weight": 324, "cookies": false, "type": "", "deprecated": false, @@ -14998,7 +15400,7 @@ }, "x-appwrite": { "method": "updateTwilioProvider", - "weight": 359, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -15096,7 +15498,7 @@ }, "x-appwrite": { "method": "createVonageProvider", - "weight": 347, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -15191,7 +15593,7 @@ }, "x-appwrite": { "method": "updateVonageProvider", - "weight": 360, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -15289,7 +15691,7 @@ }, "x-appwrite": { "method": "getProvider", - "weight": 352, + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -15342,7 +15744,7 @@ }, "x-appwrite": { "method": "deleteProvider", - "weight": 363, + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -15404,7 +15806,7 @@ }, "x-appwrite": { "method": "listProviderLogs", - "weight": 351, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -15479,7 +15881,7 @@ }, "x-appwrite": { "method": "listSubscriberLogs", - "weight": 372, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -15554,7 +15956,7 @@ }, "x-appwrite": { "method": "listTopics", - "weight": 365, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -15628,7 +16030,7 @@ }, "x-appwrite": { "method": "createTopic", - "weight": 364, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -15711,7 +16113,7 @@ }, "x-appwrite": { "method": "getTopic", - "weight": 367, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -15771,7 +16173,7 @@ }, "x-appwrite": { "method": "updateTopic", - "weight": 368, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -15848,7 +16250,7 @@ }, "x-appwrite": { "method": "deleteTopic", - "weight": 369, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -15910,7 +16312,7 @@ }, "x-appwrite": { "method": "listTopicLogs", - "weight": 366, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -15985,7 +16387,7 @@ }, "x-appwrite": { "method": "listSubscribers", - "weight": 371, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -16069,7 +16471,7 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 370, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -16160,7 +16562,7 @@ }, "x-appwrite": { "method": "getSubscriber", - "weight": 373, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -16223,7 +16625,7 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 374, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -16299,7 +16701,7 @@ }, "x-appwrite": { "method": "list", - "weight": 395, + "weight": 396, "cookies": false, "type": "", "deprecated": false, @@ -16369,7 +16771,7 @@ }, "x-appwrite": { "method": "create", - "weight": 393, + "weight": 394, "cookies": false, "type": "", "deprecated": false, @@ -16518,8 +16920,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -16605,7 +17006,7 @@ }, "x-appwrite": { "method": "listFrameworks", - "weight": 398, + "weight": 399, "cookies": false, "type": "", "deprecated": false, @@ -16632,6 +17033,56 @@ ] } }, + "\/sites\/specifications": { + "get": { + "summary": "List specifications", + "operationId": "sitesListSpecifications", + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Specifications List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/specificationList" + } + } + } + } + }, + "x-appwrite": { + "method": "listSpecifications", + "weight": 422, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/list-specifications.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed site specifications for this instance.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.read", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, "\/sites\/{siteId}": { "get": { "summary": "Get site", @@ -16654,7 +17105,7 @@ }, "x-appwrite": { "method": "get", - "weight": 394, + "weight": 395, "cookies": false, "type": "", "deprecated": false, @@ -16713,7 +17164,7 @@ }, "x-appwrite": { "method": "update", - "weight": 396, + "weight": 397, "cookies": false, "type": "", "deprecated": false, @@ -16869,8 +17320,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -16945,7 +17395,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 397, + "weight": 398, "cookies": false, "type": "", "deprecated": false, @@ -16984,6 +17434,86 @@ ] } }, + "\/sites\/{siteId}\/deployment": { + "patch": { + "summary": "Update site's deployment", + "operationId": "sitesUpdateSiteDeployment", + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Site", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/site" + } + } + } + } + }, + "x-appwrite": { + "method": "updateSiteDeployment", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/update-site-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", + "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": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + } + } + } + }, "\/sites\/{siteId}\/deployments": { "get": { "summary": "List deployments", @@ -17006,7 +17536,7 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 403, + "weight": 404, "cookies": false, "type": "", "deprecated": false, @@ -17044,7 +17574,7 @@ }, { "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", + "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: buildSize, sourceSize, buildDuration, status, activate, type", "required": false, "schema": { "type": "array", @@ -17089,7 +17619,7 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 399, + "weight": 400, "cookies": false, "type": "upload", "deprecated": false, @@ -17168,6 +17698,86 @@ } } }, + "\/sites\/{siteId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "sitesCreateDuplicateDeployment", + "tags": [ + "sites" + ], + "description": "", + "responses": { + "202": { + "description": "Deployment", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/deployment" + } + } + } + } + }, + "x-appwrite": { + "method": "createDuplicateDeployment", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/create-duplicate-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands 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.", + "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": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + } + } + } + }, "\/sites\/{siteId}\/deployments\/template": { "post": { "summary": "Create deployment", @@ -17190,7 +17800,7 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 400, + "weight": 401, "cookies": false, "type": "", "deprecated": false, @@ -17293,7 +17903,7 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 401, + "weight": 402, "cookies": false, "type": "", "deprecated": false, @@ -17389,7 +17999,7 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 402, + "weight": 403, "cookies": false, "type": "", "deprecated": false, @@ -17437,75 +18047,6 @@ } ] }, - "patch": { - "summary": "Update deployment", - "operationId": "sitesUpdateDeployment", - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "Function", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/function" - } - } - } - } - }, - "x-appwrite": { - "method": "updateDeployment", - "weight": 404, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/update-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", - "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": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, "delete": { "summary": "Delete deployment", "operationId": "sitesDeleteDeployment", @@ -17520,7 +18061,7 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 405, + "weight": 406, "cookies": false, "type": "", "deprecated": false, @@ -17569,205 +18110,6 @@ ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/build": { - "post": { - "summary": "Rebuild deployment", - "operationId": "sitesCreateDeploymentBuild", - "tags": [ - "sites" - ], - "description": "", - "responses": { - "204": { - "description": "No content" - } - }, - "x-appwrite": { - "method": "createDeploymentBuild", - "weight": 408, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/create-deployment-build.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands 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.", - "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": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "patch": { - "summary": "Cancel deployment", - "operationId": "sitesUpdateDeploymentBuild", - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "Build", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/build" - } - } - } - } - }, - "x-appwrite": { - "method": "updateDeploymentBuild", - "weight": 409, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/update-deployment-build.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and 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": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/build\/download": { - "get": { - "summary": "Download build", - "operationId": "sitesGetDeploymentBuildDownload", - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "File" - } - }, - "x-appwrite": { - "method": "getDeploymentBuildDownload", - "weight": 407, - "cookies": false, - "type": "location", - "deprecated": false, - "demo": "sites\/get-deployment-build-download.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site build content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { "get": { "summary": "Download deployment", @@ -17783,7 +18125,7 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 406, + "weight": 407, "cookies": false, "type": "location", "deprecated": false, @@ -17810,6 +18152,94 @@ "JWT": [] } ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "schema": { + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [], + "default": "source" + }, + "in": "query" + } + ] + } + }, + "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "sitesUpdateDeploymentStatus", + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Deployment", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/deployment" + } + } + } + } + }, + "x-appwrite": { + "method": "updateDeploymentStatus", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/update-deployment-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and 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", @@ -18452,7 +18882,7 @@ }, "x-appwrite": { "method": "listBuckets", - "weight": 203, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -18525,7 +18955,7 @@ }, "x-appwrite": { "method": "createBucket", - "weight": 202, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -18652,7 +19082,7 @@ }, "x-appwrite": { "method": "getBucket", - "weight": 204, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -18711,7 +19141,7 @@ }, "x-appwrite": { "method": "updateBucket", - "weight": 205, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -18835,7 +19265,7 @@ }, "x-appwrite": { "method": "deleteBucket", - "weight": 206, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -18896,7 +19326,7 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 208, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -18983,7 +19413,7 @@ }, "x-appwrite": { "method": "createFile", - "weight": 207, + "weight": 208, "cookies": false, "type": "upload", "deprecated": false, @@ -19082,7 +19512,7 @@ }, "x-appwrite": { "method": "getFile", - "weight": 209, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -19155,7 +19585,7 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 214, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -19245,7 +19675,7 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 215, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -19313,7 +19743,7 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 211, + "weight": 212, "cookies": false, "type": "location", "deprecated": false, @@ -19381,7 +19811,7 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 210, + "weight": 211, "cookies": false, "type": "location", "deprecated": false, @@ -19599,7 +20029,7 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 212, + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -19674,7 +20104,7 @@ }, "x-appwrite": { "method": "list", - "weight": 219, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -19751,7 +20181,7 @@ }, "x-appwrite": { "method": "create", - "weight": 218, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -19837,7 +20267,7 @@ }, "x-appwrite": { "method": "get", - "weight": 220, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -19900,7 +20330,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 222, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -19975,7 +20405,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 224, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -20040,7 +20470,7 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 226, + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -20127,7 +20557,7 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 225, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -20239,7 +20669,7 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 227, + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -20312,7 +20742,7 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 228, + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -20400,7 +20830,7 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 230, + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -20475,7 +20905,7 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 229, + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -20573,7 +21003,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 221, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -20634,7 +21064,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 223, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -20716,7 +21146,7 @@ }, "x-appwrite": { "method": "list", - "weight": 241, + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -20789,7 +21219,7 @@ }, "x-appwrite": { "method": "create", - "weight": 232, + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -20877,7 +21307,7 @@ }, "x-appwrite": { "method": "createArgon2User", - "weight": 235, + "weight": 236, "cookies": false, "type": "", "deprecated": false, @@ -20962,7 +21392,7 @@ }, "x-appwrite": { "method": "createBcryptUser", - "weight": 233, + "weight": 234, "cookies": false, "type": "", "deprecated": false, @@ -21047,7 +21477,7 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 249, + "weight": 250, "cookies": false, "type": "", "deprecated": false, @@ -21115,7 +21545,7 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 272, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -21176,7 +21606,7 @@ }, "x-appwrite": { "method": "createMD5User", - "weight": 234, + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -21261,7 +21691,7 @@ }, "x-appwrite": { "method": "createPHPassUser", - "weight": 237, + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -21346,7 +21776,7 @@ }, "x-appwrite": { "method": "createScryptUser", - "weight": 238, + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -21461,7 +21891,7 @@ }, "x-appwrite": { "method": "createScryptModifiedUser", - "weight": 239, + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -21564,7 +21994,7 @@ }, "x-appwrite": { "method": "createSHAUser", - "weight": 236, + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -21669,7 +22099,7 @@ }, "x-appwrite": { "method": "get", - "weight": 242, + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -21721,7 +22151,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 270, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -21782,7 +22212,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 255, + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -21862,7 +22292,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 273, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -21944,7 +22374,7 @@ }, "x-appwrite": { "method": "updateLabels", - "weight": 251, + "weight": 252, "cookies": false, "type": "", "deprecated": false, @@ -22027,7 +22457,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 247, + "weight": 248, "cookies": false, "type": "", "deprecated": false, @@ -22101,7 +22531,7 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 246, + "weight": 247, "cookies": false, "type": "", "deprecated": false, @@ -22162,7 +22592,7 @@ }, "x-appwrite": { "method": "updateMfa", - "weight": 260, + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -22235,7 +22665,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 265, + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -22311,7 +22741,7 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 261, + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -22372,7 +22802,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 262, + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -22431,7 +22861,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 264, + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -22490,7 +22920,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 263, + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -22551,7 +22981,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 253, + "weight": 254, "cookies": false, "type": "", "deprecated": false, @@ -22631,7 +23061,7 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 254, + "weight": 255, "cookies": false, "type": "", "deprecated": false, @@ -22711,7 +23141,7 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 256, + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -22791,7 +23221,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 243, + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -22850,7 +23280,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 258, + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -22930,7 +23360,7 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 245, + "weight": 246, "cookies": false, "type": "", "deprecated": false, @@ -22989,7 +23419,7 @@ }, "x-appwrite": { "method": "createSession", - "weight": 266, + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -23041,7 +23471,7 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 269, + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -23095,7 +23525,7 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 268, + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -23166,7 +23596,7 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 250, + "weight": 251, "cookies": false, "type": "", "deprecated": false, @@ -23246,7 +23676,7 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 248, + "weight": 249, "cookies": false, "type": "", "deprecated": false, @@ -23319,7 +23749,7 @@ }, "x-appwrite": { "method": "createTarget", - "weight": 240, + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -23429,7 +23859,7 @@ }, "x-appwrite": { "method": "getTarget", - "weight": 244, + "weight": 245, "cookies": false, "type": "", "deprecated": false, @@ -23499,7 +23929,7 @@ }, "x-appwrite": { "method": "updateTarget", - "weight": 259, + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -23588,7 +24018,7 @@ }, "x-appwrite": { "method": "deleteTarget", - "weight": 271, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -23660,7 +24090,7 @@ }, "x-appwrite": { "method": "createToken", - "weight": 267, + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -23742,7 +24172,7 @@ }, "x-appwrite": { "method": "updateEmailVerification", - "weight": 257, + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -23822,7 +24252,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 252, + "weight": 253, "cookies": false, "type": "", "deprecated": false, @@ -27452,7 +27882,7 @@ "description": "The entrypoint file to use to execute the deployment code.", "x-example": "index.js" }, - "size": { + "sourceSize": { "type": "integer", "description": "The code size in bytes.", "x-example": 128, @@ -27494,7 +27924,7 @@ "description": "The build logs.", "x-example": "Compiling source files..." }, - "buildTime": { + "buildDuration": { "type": "integer", "description": "The current build time in seconds.", "x-example": 128, @@ -27559,7 +27989,7 @@ "resourceId", "resourceType", "entrypoint", - "size", + "sourceSize", "buildSize", "buildId", "activate", @@ -27567,7 +27997,7 @@ "screenshotDark", "status", "buildLogs", - "buildTime", + "buildDuration", "providerRepositoryName", "providerRepositoryOwner", "providerRepositoryUrl", @@ -27711,70 +28141,6 @@ "duration" ] }, - "build": { - "description": "Build", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Build ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentId": { - "type": "string", - "description": "The deployment that created this build.", - "x-example": "5e5ea5c16897e" - }, - "status": { - "type": "string", - "description": "The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built", - "x-example": "ready" - }, - "stdout": { - "type": "string", - "description": "The stdout of the build.", - "x-example": "" - }, - "stderr": { - "type": "string", - "description": "The stderr of the build.", - "x-example": "" - }, - "startTime": { - "type": "string", - "description": "The deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "endTime": { - "type": "string", - "description": "The time the build was finished in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "duration": { - "type": "integer", - "description": "The build duration in seconds.", - "x-example": 0, - "format": "int32" - }, - "size": { - "type": "integer", - "description": "The code size in bytes.", - "x-example": 128, - "format": "int32" - } - }, - "required": [ - "$id", - "deploymentId", - "status", - "stdout", - "stderr", - "startTime", - "endTime", - "duration", - "size" - ] - }, "variable": { "description": "Variable", "type": "object", diff --git a/app/config/specs/swagger2-latest-client.json b/app/config/specs/swagger2-latest-client.json index f646dbd81a..c419af3260 100644 --- a/app/config/specs/swagger2-latest-client.json +++ b/app/config/specs/swagger2-latest-client.json @@ -87,7 +87,7 @@ }, "x-appwrite": { "method": "get", - "weight": 9, + "weight": 10, "cookies": false, "type": "", "deprecated": false, @@ -137,7 +137,7 @@ }, "x-appwrite": { "method": "create", - "weight": 8, + "weight": 9, "cookies": false, "type": "", "deprecated": false, @@ -227,7 +227,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 34, + "weight": 35, "cookies": false, "type": "", "deprecated": false, @@ -306,7 +306,7 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 57, + "weight": 58, "cookies": false, "type": "", "deprecated": false, @@ -367,7 +367,7 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 58, + "weight": 59, "cookies": false, "type": "", "deprecated": false, @@ -429,7 +429,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 29, + "weight": 30, "cookies": false, "type": "", "deprecated": false, @@ -479,7 +479,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 31, + "weight": 32, "cookies": false, "type": "", "deprecated": false, @@ -545,7 +545,7 @@ }, "x-appwrite": { "method": "updateMFA", - "weight": 44, + "weight": 45, "cookies": false, "type": "", "deprecated": false, @@ -617,7 +617,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", - "weight": 46, + "weight": 47, "cookies": false, "type": "", "deprecated": false, @@ -682,7 +682,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", - "weight": 47, + "weight": 48, "cookies": false, "type": "", "deprecated": false, @@ -760,7 +760,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 51, + "weight": 52, "cookies": false, "type": "", "deprecated": false, @@ -827,7 +827,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", - "weight": 52, + "weight": 53, "cookies": false, "type": "", "deprecated": false, @@ -903,7 +903,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", - "weight": 53, + "weight": 54, "cookies": false, "type": "", "deprecated": false, @@ -982,7 +982,7 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 45, + "weight": 46, "cookies": false, "type": "", "deprecated": false, @@ -1034,7 +1034,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 50, + "weight": 51, "cookies": false, "type": "", "deprecated": false, @@ -1084,7 +1084,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 48, + "weight": 49, "cookies": false, "type": "", "deprecated": false, @@ -1134,7 +1134,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 49, + "weight": 50, "cookies": false, "type": "", "deprecated": false, @@ -1186,7 +1186,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 32, + "weight": 33, "cookies": false, "type": "", "deprecated": false, @@ -1258,7 +1258,7 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 33, + "weight": 34, "cookies": false, "type": "", "deprecated": false, @@ -1336,7 +1336,7 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 35, + "weight": 36, "cookies": false, "type": "", "deprecated": false, @@ -1415,7 +1415,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 30, + "weight": 31, "cookies": false, "type": "", "deprecated": false, @@ -1465,7 +1465,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 36, + "weight": 37, "cookies": false, "type": "", "deprecated": false, @@ -1537,7 +1537,7 @@ }, "x-appwrite": { "method": "createRecovery", - "weight": 38, + "weight": 39, "cookies": false, "type": "", "deprecated": false, @@ -1617,7 +1617,7 @@ }, "x-appwrite": { "method": "updateRecovery", - "weight": 39, + "weight": 40, "cookies": false, "type": "", "deprecated": false, @@ -1703,7 +1703,7 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 11, + "weight": 12, "cookies": false, "type": "", "deprecated": false, @@ -1748,7 +1748,7 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 12, + "weight": 13, "cookies": false, "type": "", "deprecated": false, @@ -1800,7 +1800,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", - "weight": 17, + "weight": 18, "cookies": false, "type": "", "deprecated": false, @@ -1850,7 +1850,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", - "weight": 16, + "weight": 17, "cookies": false, "type": "", "deprecated": false, @@ -1927,7 +1927,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", - "weight": 26, + "weight": 27, "cookies": false, "type": "", "deprecated": true, @@ -2001,7 +2001,7 @@ }, "x-appwrite": { "method": "createOAuth2Session", - "weight": 19, + "weight": 20, "cookies": false, "type": "webAuth", "deprecated": false, @@ -2136,7 +2136,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", - "weight": 27, + "weight": 28, "cookies": false, "type": "", "deprecated": true, @@ -2213,7 +2213,7 @@ }, "x-appwrite": { "method": "createSession", - "weight": 18, + "weight": 19, "cookies": false, "type": "", "deprecated": false, @@ -2290,7 +2290,7 @@ }, "x-appwrite": { "method": "getSession", - "weight": 13, + "weight": 14, "cookies": false, "type": "", "deprecated": false, @@ -2350,7 +2350,7 @@ }, "x-appwrite": { "method": "updateSession", - "weight": 15, + "weight": 16, "cookies": false, "type": "", "deprecated": false, @@ -2405,7 +2405,7 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 14, + "weight": 15, "cookies": false, "type": "", "deprecated": false, @@ -2467,7 +2467,7 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 37, + "weight": 38, "cookies": false, "type": "", "deprecated": false, @@ -2519,7 +2519,7 @@ }, "x-appwrite": { "method": "createPushTarget", - "weight": 54, + "weight": 55, "cookies": false, "type": "", "deprecated": false, @@ -2602,7 +2602,7 @@ }, "x-appwrite": { "method": "updatePushTarget", - "weight": 55, + "weight": 56, "cookies": false, "type": "", "deprecated": false, @@ -2673,7 +2673,7 @@ }, "x-appwrite": { "method": "deletePushTarget", - "weight": 56, + "weight": 57, "cookies": false, "type": "", "deprecated": false, @@ -2733,7 +2733,7 @@ }, "x-appwrite": { "method": "createEmailToken", - "weight": 25, + "weight": 26, "cookies": false, "type": "", "deprecated": false, @@ -2816,7 +2816,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", - "weight": 24, + "weight": 25, "cookies": false, "type": "", "deprecated": false, @@ -2905,7 +2905,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", - "weight": 23, + "weight": 24, "cookies": false, "type": "webAuth", "deprecated": false, @@ -3040,7 +3040,7 @@ }, "x-appwrite": { "method": "createPhoneToken", - "weight": 28, + "weight": 29, "cookies": false, "type": "", "deprecated": false, @@ -3120,7 +3120,7 @@ }, "x-appwrite": { "method": "createVerification", - "weight": 40, + "weight": 41, "cookies": false, "type": "", "deprecated": false, @@ -3190,7 +3190,7 @@ }, "x-appwrite": { "method": "updateVerification", - "weight": 41, + "weight": 42, "cookies": false, "type": "", "deprecated": false, @@ -3269,7 +3269,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", - "weight": 42, + "weight": 43, "cookies": false, "type": "", "deprecated": false, @@ -3322,7 +3322,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 43, + "weight": 44, "cookies": false, "type": "", "deprecated": false, @@ -3401,7 +3401,7 @@ }, "x-appwrite": { "method": "getBrowser", - "weight": 60, + "weight": 61, "cookies": false, "type": "location", "deprecated": false, @@ -3527,7 +3527,7 @@ }, "x-appwrite": { "method": "getCreditCard", - "weight": 59, + "weight": 60, "cookies": false, "type": "location", "deprecated": false, @@ -3659,7 +3659,7 @@ }, "x-appwrite": { "method": "getFavicon", - "weight": 63, + "weight": 64, "cookies": false, "type": "location", "deprecated": false, @@ -3723,7 +3723,7 @@ }, "x-appwrite": { "method": "getFlag", - "weight": 61, + "weight": 62, "cookies": false, "type": "location", "deprecated": false, @@ -4211,7 +4211,7 @@ }, "x-appwrite": { "method": "getImage", - "weight": 62, + "weight": 63, "cookies": false, "type": "location", "deprecated": false, @@ -4295,7 +4295,7 @@ }, "x-appwrite": { "method": "getInitials", - "weight": 65, + "weight": 66, "cookies": false, "type": "location", "deprecated": false, @@ -4387,7 +4387,7 @@ }, "x-appwrite": { "method": "getQR", - "weight": 64, + "weight": 65, "cookies": false, "type": "location", "deprecated": false, @@ -4479,7 +4479,7 @@ }, "x-appwrite": { "method": "listDocuments", - "weight": 109, + "weight": 110, "cookies": false, "type": "", "deprecated": false, @@ -4560,7 +4560,7 @@ }, "x-appwrite": { "method": "createDocument", - "weight": 108, + "weight": 109, "cookies": false, "type": "", "deprecated": false, @@ -4665,7 +4665,7 @@ }, "x-appwrite": { "method": "getDocument", - "weight": 110, + "weight": 111, "cookies": false, "type": "", "deprecated": false, @@ -4754,7 +4754,7 @@ }, "x-appwrite": { "method": "updateDocument", - "weight": 112, + "weight": 113, "cookies": false, "type": "", "deprecated": false, @@ -4850,7 +4850,7 @@ }, "x-appwrite": { "method": "deleteDocument", - "weight": 113, + "weight": 114, "cookies": false, "type": "", "deprecated": false, @@ -4918,7 +4918,7 @@ "tags": [ "functions" ], - "description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.", + "description": "", "responses": { "200": { "description": "Executions List", @@ -4929,12 +4929,12 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 301, + "weight": 383, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-executions.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the current user function execution logs. You can use the query params to filter your results.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -5000,7 +5000,7 @@ "tags": [ "functions" ], - "description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", + "description": "", "responses": { "201": { "description": "Execution", @@ -5011,12 +5011,12 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 300, + "weight": 381, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/create-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterTrigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -5118,7 +5118,7 @@ "tags": [ "functions" ], - "description": "Get a function execution log by its unique ID.", + "description": "", "responses": { "200": { "description": "Execution", @@ -5129,12 +5129,12 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 302, + "weight": 382, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function execution log by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -5200,7 +5200,7 @@ }, "x-appwrite": { "method": "query", - "weight": 325, + "weight": 303, "cookies": false, "type": "graphql", "deprecated": false, @@ -5273,7 +5273,7 @@ }, "x-appwrite": { "method": "mutation", - "weight": 324, + "weight": 302, "cookies": false, "type": "graphql", "deprecated": false, @@ -5346,7 +5346,7 @@ }, "x-appwrite": { "method": "get", - "weight": 117, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -5399,7 +5399,7 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 118, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -5452,7 +5452,7 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 122, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -5505,7 +5505,7 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 119, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -5558,7 +5558,7 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 120, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -5611,7 +5611,7 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 121, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -5664,7 +5664,7 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 123, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -5717,7 +5717,7 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 124, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -5770,7 +5770,7 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 370, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -5854,7 +5854,7 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 374, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -5926,7 +5926,7 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 208, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -6008,7 +6008,7 @@ }, "x-appwrite": { "method": "createFile", - "weight": 207, + "weight": 208, "cookies": false, "type": "upload", "deprecated": false, @@ -6099,7 +6099,7 @@ }, "x-appwrite": { "method": "getFile", - "weight": 209, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -6168,7 +6168,7 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 214, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -6256,7 +6256,7 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 215, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -6327,7 +6327,7 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 211, + "weight": 212, "cookies": false, "type": "location", "deprecated": false, @@ -6398,7 +6398,7 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 210, + "weight": 211, "cookies": false, "type": "location", "deprecated": false, @@ -6597,7 +6597,7 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 212, + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -6668,7 +6668,7 @@ }, "x-appwrite": { "method": "list", - "weight": 219, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -6742,7 +6742,7 @@ }, "x-appwrite": { "method": "create", - "weight": 218, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -6833,7 +6833,7 @@ }, "x-appwrite": { "method": "get", - "weight": 220, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -6894,7 +6894,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 222, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -6968,7 +6968,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 224, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -7031,7 +7031,7 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 226, + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -7113,7 +7113,7 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 225, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -7227,7 +7227,7 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 227, + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -7296,7 +7296,7 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 228, + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -7381,7 +7381,7 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 230, + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -7452,7 +7452,7 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 229, + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -7547,7 +7547,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 221, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -7607,7 +7607,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 223, + "weight": 224, "cookies": false, "type": "", "deprecated": false, diff --git a/app/config/specs/swagger2-latest-console.json b/app/config/specs/swagger2-latest-console.json index 8b6dfb954d..641798bf2f 100644 --- a/app/config/specs/swagger2-latest-console.json +++ b/app/config/specs/swagger2-latest-console.json @@ -99,7 +99,7 @@ }, "x-appwrite": { "method": "get", - "weight": 9, + "weight": 10, "cookies": false, "type": "", "deprecated": false, @@ -148,7 +148,7 @@ }, "x-appwrite": { "method": "create", - "weight": 8, + "weight": 9, "cookies": false, "type": "", "deprecated": false, @@ -231,7 +231,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 10, + "weight": 11, "cookies": false, "type": "", "deprecated": false, @@ -280,7 +280,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 34, + "weight": 35, "cookies": false, "type": "", "deprecated": false, @@ -358,7 +358,7 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 57, + "weight": 58, "cookies": false, "type": "", "deprecated": false, @@ -418,7 +418,7 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 58, + "weight": 59, "cookies": false, "type": "", "deprecated": false, @@ -479,7 +479,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 29, + "weight": 30, "cookies": false, "type": "", "deprecated": false, @@ -529,7 +529,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 31, + "weight": 32, "cookies": false, "type": "", "deprecated": false, @@ -594,7 +594,7 @@ }, "x-appwrite": { "method": "updateMFA", - "weight": 44, + "weight": 45, "cookies": false, "type": "", "deprecated": false, @@ -665,7 +665,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", - "weight": 46, + "weight": 47, "cookies": false, "type": "", "deprecated": false, @@ -729,7 +729,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", - "weight": 47, + "weight": 48, "cookies": false, "type": "", "deprecated": false, @@ -806,7 +806,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 51, + "weight": 52, "cookies": false, "type": "", "deprecated": false, @@ -872,7 +872,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", - "weight": 52, + "weight": 53, "cookies": false, "type": "", "deprecated": false, @@ -948,7 +948,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", - "weight": 53, + "weight": 54, "cookies": false, "type": "", "deprecated": false, @@ -1026,7 +1026,7 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 45, + "weight": 46, "cookies": false, "type": "", "deprecated": false, @@ -1077,7 +1077,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 50, + "weight": 51, "cookies": false, "type": "", "deprecated": false, @@ -1126,7 +1126,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 48, + "weight": 49, "cookies": false, "type": "", "deprecated": false, @@ -1175,7 +1175,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 49, + "weight": 50, "cookies": false, "type": "", "deprecated": false, @@ -1226,7 +1226,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 32, + "weight": 33, "cookies": false, "type": "", "deprecated": false, @@ -1297,7 +1297,7 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 33, + "weight": 34, "cookies": false, "type": "", "deprecated": false, @@ -1374,7 +1374,7 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 35, + "weight": 36, "cookies": false, "type": "", "deprecated": false, @@ -1452,7 +1452,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 30, + "weight": 31, "cookies": false, "type": "", "deprecated": false, @@ -1501,7 +1501,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 36, + "weight": 37, "cookies": false, "type": "", "deprecated": false, @@ -1572,7 +1572,7 @@ }, "x-appwrite": { "method": "createRecovery", - "weight": 38, + "weight": 39, "cookies": false, "type": "", "deprecated": false, @@ -1651,7 +1651,7 @@ }, "x-appwrite": { "method": "updateRecovery", - "weight": 39, + "weight": 40, "cookies": false, "type": "", "deprecated": false, @@ -1736,7 +1736,7 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 11, + "weight": 12, "cookies": false, "type": "", "deprecated": false, @@ -1780,7 +1780,7 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 12, + "weight": 13, "cookies": false, "type": "", "deprecated": false, @@ -1831,7 +1831,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", - "weight": 17, + "weight": 18, "cookies": false, "type": "", "deprecated": false, @@ -1881,7 +1881,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", - "weight": 16, + "weight": 17, "cookies": false, "type": "", "deprecated": false, @@ -1958,7 +1958,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", - "weight": 26, + "weight": 27, "cookies": false, "type": "", "deprecated": true, @@ -2032,7 +2032,7 @@ }, "x-appwrite": { "method": "createOAuth2Session", - "weight": 19, + "weight": 20, "cookies": false, "type": "webAuth", "deprecated": false, @@ -2167,7 +2167,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", - "weight": 27, + "weight": 28, "cookies": false, "type": "", "deprecated": true, @@ -2244,7 +2244,7 @@ }, "x-appwrite": { "method": "createSession", - "weight": 18, + "weight": 19, "cookies": false, "type": "", "deprecated": false, @@ -2321,7 +2321,7 @@ }, "x-appwrite": { "method": "getSession", - "weight": 13, + "weight": 14, "cookies": false, "type": "", "deprecated": false, @@ -2380,7 +2380,7 @@ }, "x-appwrite": { "method": "updateSession", - "weight": 15, + "weight": 16, "cookies": false, "type": "", "deprecated": false, @@ -2434,7 +2434,7 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 14, + "weight": 15, "cookies": false, "type": "", "deprecated": false, @@ -2495,7 +2495,7 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 37, + "weight": 38, "cookies": false, "type": "", "deprecated": false, @@ -2546,7 +2546,7 @@ }, "x-appwrite": { "method": "createPushTarget", - "weight": 54, + "weight": 55, "cookies": false, "type": "", "deprecated": false, @@ -2628,7 +2628,7 @@ }, "x-appwrite": { "method": "updatePushTarget", - "weight": 55, + "weight": 56, "cookies": false, "type": "", "deprecated": false, @@ -2698,7 +2698,7 @@ }, "x-appwrite": { "method": "deletePushTarget", - "weight": 56, + "weight": 57, "cookies": false, "type": "", "deprecated": false, @@ -2757,7 +2757,7 @@ }, "x-appwrite": { "method": "createEmailToken", - "weight": 25, + "weight": 26, "cookies": false, "type": "", "deprecated": false, @@ -2840,7 +2840,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", - "weight": 24, + "weight": 25, "cookies": false, "type": "", "deprecated": false, @@ -2929,7 +2929,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", - "weight": 23, + "weight": 24, "cookies": false, "type": "webAuth", "deprecated": false, @@ -3064,7 +3064,7 @@ }, "x-appwrite": { "method": "createPhoneToken", - "weight": 28, + "weight": 29, "cookies": false, "type": "", "deprecated": false, @@ -3144,7 +3144,7 @@ }, "x-appwrite": { "method": "createVerification", - "weight": 40, + "weight": 41, "cookies": false, "type": "", "deprecated": false, @@ -3213,7 +3213,7 @@ }, "x-appwrite": { "method": "updateVerification", - "weight": 41, + "weight": 42, "cookies": false, "type": "", "deprecated": false, @@ -3291,7 +3291,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", - "weight": 42, + "weight": 43, "cookies": false, "type": "", "deprecated": false, @@ -3343,7 +3343,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 43, + "weight": 44, "cookies": false, "type": "", "deprecated": false, @@ -3421,7 +3421,7 @@ }, "x-appwrite": { "method": "getBrowser", - "weight": 60, + "weight": 61, "cookies": false, "type": "location", "deprecated": false, @@ -3547,7 +3547,7 @@ }, "x-appwrite": { "method": "getCreditCard", - "weight": 59, + "weight": 60, "cookies": false, "type": "location", "deprecated": false, @@ -3679,7 +3679,7 @@ }, "x-appwrite": { "method": "getFavicon", - "weight": 63, + "weight": 64, "cookies": false, "type": "location", "deprecated": false, @@ -3743,7 +3743,7 @@ }, "x-appwrite": { "method": "getFlag", - "weight": 61, + "weight": 62, "cookies": false, "type": "location", "deprecated": false, @@ -4231,7 +4231,7 @@ }, "x-appwrite": { "method": "getImage", - "weight": 62, + "weight": 63, "cookies": false, "type": "location", "deprecated": false, @@ -4315,7 +4315,7 @@ }, "x-appwrite": { "method": "getInitials", - "weight": 65, + "weight": 66, "cookies": false, "type": "location", "deprecated": false, @@ -4407,7 +4407,7 @@ }, "x-appwrite": { "method": "getQR", - "weight": 64, + "weight": 65, "cookies": false, "type": "location", "deprecated": false, @@ -4499,7 +4499,7 @@ }, "x-appwrite": { "method": "chat", - "weight": 327, + "weight": 305, "cookies": false, "type": "", "deprecated": false, @@ -4563,7 +4563,7 @@ }, "x-appwrite": { "method": "getResource", - "weight": 422, + "weight": 423, "cookies": false, "type": "", "deprecated": false, @@ -4635,7 +4635,7 @@ }, "x-appwrite": { "method": "variables", - "weight": 326, + "weight": 304, "cookies": false, "type": "", "deprecated": false, @@ -4684,7 +4684,7 @@ }, "x-appwrite": { "method": "list", - "weight": 70, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -4755,7 +4755,7 @@ }, "x-appwrite": { "method": "create", - "weight": 69, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -4838,7 +4838,7 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 114, + "weight": 115, "cookies": false, "type": "", "deprecated": false, @@ -4909,7 +4909,7 @@ }, "x-appwrite": { "method": "get", - "weight": 71, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -4967,7 +4967,7 @@ }, "x-appwrite": { "method": "update", - "weight": 73, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -5044,7 +5044,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 74, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -5104,7 +5104,7 @@ }, "x-appwrite": { "method": "listCollections", - "weight": 76, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -5183,7 +5183,7 @@ }, "x-appwrite": { "method": "createCollection", - "weight": 75, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -5289,7 +5289,7 @@ }, "x-appwrite": { "method": "getCollection", - "weight": 77, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -5355,7 +5355,7 @@ }, "x-appwrite": { "method": "updateCollection", - "weight": 79, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -5455,7 +5455,7 @@ }, "x-appwrite": { "method": "deleteCollection", - "weight": 80, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -5523,7 +5523,7 @@ }, "x-appwrite": { "method": "listAttributes", - "weight": 91, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -5603,7 +5603,7 @@ }, "x-appwrite": { "method": "createBooleanAttribute", - "weight": 88, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -5708,7 +5708,7 @@ }, "x-appwrite": { "method": "updateBooleanAttribute", - "weight": 100, + "weight": 101, "cookies": false, "type": "", "deprecated": false, @@ -5815,7 +5815,7 @@ }, "x-appwrite": { "method": "createDatetimeAttribute", - "weight": 89, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -5920,7 +5920,7 @@ }, "x-appwrite": { "method": "updateDatetimeAttribute", - "weight": 101, + "weight": 102, "cookies": false, "type": "", "deprecated": false, @@ -6027,7 +6027,7 @@ }, "x-appwrite": { "method": "createEmailAttribute", - "weight": 82, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -6132,7 +6132,7 @@ }, "x-appwrite": { "method": "updateEmailAttribute", - "weight": 94, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -6239,7 +6239,7 @@ }, "x-appwrite": { "method": "createEnumAttribute", - "weight": 83, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -6354,7 +6354,7 @@ }, "x-appwrite": { "method": "updateEnumAttribute", - "weight": 95, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -6471,7 +6471,7 @@ }, "x-appwrite": { "method": "createFloatAttribute", - "weight": 87, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -6588,7 +6588,7 @@ }, "x-appwrite": { "method": "updateFloatAttribute", - "weight": 99, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -6709,7 +6709,7 @@ }, "x-appwrite": { "method": "createIntegerAttribute", - "weight": 86, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -6826,7 +6826,7 @@ }, "x-appwrite": { "method": "updateIntegerAttribute", - "weight": 98, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -6947,7 +6947,7 @@ }, "x-appwrite": { "method": "createIpAttribute", - "weight": 84, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -7052,7 +7052,7 @@ }, "x-appwrite": { "method": "updateIpAttribute", - "weight": 96, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -7159,7 +7159,7 @@ }, "x-appwrite": { "method": "createRelationshipAttribute", - "weight": 90, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -7291,7 +7291,7 @@ }, "x-appwrite": { "method": "createStringAttribute", - "weight": 81, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -7409,7 +7409,7 @@ }, "x-appwrite": { "method": "updateStringAttribute", - "weight": 93, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -7522,7 +7522,7 @@ }, "x-appwrite": { "method": "createUrlAttribute", - "weight": 85, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -7627,7 +7627,7 @@ }, "x-appwrite": { "method": "updateUrlAttribute", - "weight": 97, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -7765,7 +7765,7 @@ }, "x-appwrite": { "method": "getAttribute", - "weight": 92, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -7833,7 +7833,7 @@ }, "x-appwrite": { "method": "deleteAttribute", - "weight": 103, + "weight": 104, "cookies": false, "type": "", "deprecated": false, @@ -7908,7 +7908,7 @@ }, "x-appwrite": { "method": "updateRelationshipAttribute", - "weight": 102, + "weight": 103, "cookies": false, "type": "", "deprecated": false, @@ -8011,7 +8011,7 @@ }, "x-appwrite": { "method": "listDocuments", - "weight": 109, + "weight": 110, "cookies": false, "type": "", "deprecated": false, @@ -8092,7 +8092,7 @@ }, "x-appwrite": { "method": "createDocument", - "weight": 108, + "weight": 109, "cookies": false, "type": "", "deprecated": false, @@ -8197,7 +8197,7 @@ }, "x-appwrite": { "method": "getDocument", - "weight": 110, + "weight": 111, "cookies": false, "type": "", "deprecated": false, @@ -8286,7 +8286,7 @@ }, "x-appwrite": { "method": "updateDocument", - "weight": 112, + "weight": 113, "cookies": false, "type": "", "deprecated": false, @@ -8382,7 +8382,7 @@ }, "x-appwrite": { "method": "deleteDocument", - "weight": 113, + "weight": 114, "cookies": false, "type": "", "deprecated": false, @@ -8461,7 +8461,7 @@ }, "x-appwrite": { "method": "listDocumentLogs", - "weight": 111, + "weight": 112, "cookies": false, "type": "", "deprecated": false, @@ -8548,7 +8548,7 @@ }, "x-appwrite": { "method": "listIndexes", - "weight": 105, + "weight": 106, "cookies": false, "type": "", "deprecated": false, @@ -8626,7 +8626,7 @@ }, "x-appwrite": { "method": "createIndex", - "weight": 104, + "weight": 105, "cookies": false, "type": "", "deprecated": false, @@ -8745,7 +8745,7 @@ }, "x-appwrite": { "method": "getIndex", - "weight": 106, + "weight": 107, "cookies": false, "type": "", "deprecated": false, @@ -8813,7 +8813,7 @@ }, "x-appwrite": { "method": "deleteIndex", - "weight": 107, + "weight": 108, "cookies": false, "type": "", "deprecated": false, @@ -8888,7 +8888,7 @@ }, "x-appwrite": { "method": "listCollectionLogs", - "weight": 78, + "weight": 79, "cookies": false, "type": "", "deprecated": false, @@ -8967,7 +8967,7 @@ }, "x-appwrite": { "method": "getCollectionUsage", - "weight": 116, + "weight": 117, "cookies": false, "type": "", "deprecated": false, @@ -9054,7 +9054,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 72, + "weight": 73, "cookies": false, "type": "", "deprecated": false, @@ -9125,7 +9125,7 @@ }, "x-appwrite": { "method": "getDatabaseUsage", - "weight": 115, + "weight": 116, "cookies": false, "type": "", "deprecated": false, @@ -9204,7 +9204,7 @@ }, "x-appwrite": { "method": "list", - "weight": 388, + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -9275,7 +9275,7 @@ }, "x-appwrite": { "method": "create", - "weight": 386, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -9384,8 +9384,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -9524,7 +9523,7 @@ }, "x-appwrite": { "method": "listRuntimes", - "weight": 389, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -9552,7 +9551,7 @@ }, "\/functions\/specifications": { "get": { - "summary": "List available function runtime specifications", + "summary": "List specifications", "operationId": "functionsListSpecifications", "consumes": [ "application\/json" @@ -9563,7 +9562,7 @@ "tags": [ "functions" ], - "description": "List allowed function specifications for this instance.\n", + "description": "", "responses": { "200": { "description": "Specifications List", @@ -9574,12 +9573,12 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 288, + "weight": 370, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-specifications.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-specifications.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed function specifications for this instance.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9603,7 +9602,7 @@ }, "\/functions\/templates": { "get": { - "summary": "List function templates", + "summary": "List templates", "operationId": "functionsListTemplates", "consumes": [ "application\/json" @@ -9614,7 +9613,7 @@ "tags": [ "functions" ], - "description": "List available function templates. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.", + "description": "", "responses": { "200": { "description": "Function Templates List", @@ -9625,12 +9624,12 @@ }, "x-appwrite": { "method": "listTemplates", - "weight": 309, + "weight": 393, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-templates.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-templates.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList available function templates. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9709,7 +9708,7 @@ "tags": [ "functions" ], - "description": "Get a function template using ID. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.", + "description": "", "responses": { "200": { "description": "Template Function", @@ -9720,12 +9719,12 @@ }, "x-appwrite": { "method": "getTemplate", - "weight": 310, + "weight": 392, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-template.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-template.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function template using ID. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9758,7 +9757,7 @@ "\/functions\/usage": { "get": { "summary": "Get functions usage", - "operationId": "functionsGetUsage", + "operationId": "functionsListUsage", "consumes": [ "application\/json" ], @@ -9768,7 +9767,7 @@ "tags": [ "functions" ], - "description": "Get usage metrics and statistics for a for all functions. View statistics including total functions, deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", + "description": "", "responses": { "200": { "description": "UsageFunctions", @@ -9778,13 +9777,13 @@ } }, "x-appwrite": { - "method": "getUsage", - "weight": 291, + "method": "listUsage", + "weight": 386, "cookies": false, "type": "", "deprecated": false, - "demo": "functions\/get-usage.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-functions-usage.md", + "demo": "functions\/list-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet usage metrics and statistics for all functions in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9814,12 +9813,8 @@ "30d", "90d" ], - "x-enum-name": "FunctionUsageRange", - "x-enum-keys": [ - "Twenty Four Hours", - "Thirty Days", - "Ninety Days" - ], + "x-enum-name": null, + "x-enum-keys": [], "default": "30d", "in": "query" } @@ -9839,7 +9834,7 @@ "tags": [ "functions" ], - "description": "Get a function by its unique ID.", + "description": "", "responses": { "200": { "description": "Function", @@ -9850,12 +9845,12 @@ }, "x-appwrite": { "method": "get", - "weight": 289, + "weight": 365, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9908,7 +9903,7 @@ }, "x-appwrite": { "method": "update", - "weight": 387, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -10019,8 +10014,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -10143,7 +10137,7 @@ "tags": [ "functions" ], - "description": "Delete a function by its unique ID.", + "description": "", "responses": { "204": { "description": "No content" @@ -10151,12 +10145,12 @@ }, "x-appwrite": { "method": "delete", - "weight": 294, + "weight": 368, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10187,6 +10181,84 @@ ] } }, + "\/functions\/{functionId}\/deployment": { + "patch": { + "summary": "Update function's deployment", + "operationId": "functionsUpdateFunctionDeployment", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Function", + "schema": { + "$ref": "#\/definitions\/function" + } + } + }, + "x-appwrite": { + "method": "updateFunctionDeployment", + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-function-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.", + "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": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + ] + } + }, "\/functions\/{functionId}\/deployments": { "get": { "summary": "List deployments", @@ -10200,7 +10272,7 @@ "tags": [ "functions" ], - "description": "Get a list of all the function's code deployments. You can use the query params to filter your results.", + "description": "", "responses": { "200": { "description": "Deployments List", @@ -10211,12 +10283,12 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 295, + "weight": 374, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-deployments.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the function's code deployments. You can use the query params to filter your results.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10246,7 +10318,7 @@ }, { "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", + "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: buildSize, sourceSize, buildDuration, status, activate, type", "required": false, "type": "array", "collectionFormat": "multi", @@ -10290,7 +10362,7 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 390, + "weight": 371, "cookies": false, "type": "upload", "deprecated": false, @@ -10357,6 +10429,90 @@ ] } }, + "\/functions\/{functionId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "functionsCreateDuplicateDeployment", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "202": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } + } + }, + "x-appwrite": { + "method": "createDuplicateDeployment", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/create-duplicate-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate 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.", + "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": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + }, + "buildId": { + "type": "string", + "description": "Build unique ID.", + "default": "", + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + ] + } + }, "\/functions\/{functionId}\/deployments\/template": { "post": { "summary": "Create template deployment", @@ -10381,7 +10537,7 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 391, + "weight": 376, "cookies": false, "type": "", "deprecated": false, @@ -10486,7 +10642,7 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 392, + "weight": 377, "cookies": false, "type": "", "deprecated": false, @@ -10571,7 +10727,7 @@ "tags": [ "functions" ], - "description": "Get a code deployment by its unique ID.", + "description": "", "responses": { "200": { "description": "Deployment", @@ -10582,12 +10738,12 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 296, + "weight": 372, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10635,7 +10791,7 @@ "tags": [ "functions" ], - "description": "Delete a code deployment by its unique ID.", + "description": "", "responses": { "204": { "description": "No content" @@ -10643,12 +10799,12 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 297, + "weight": 375, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a code deployment by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10687,86 +10843,6 @@ ] } }, - "\/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": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "buildId": { - "type": "string", - "description": "Build unique ID.", - "default": "", - "x-example": "" - } - } - } - } - ] - } - }, "\/functions\/{functionId}\/deployments\/{deploymentId}\/download": { "get": { "summary": "Download deployment", @@ -10780,7 +10856,7 @@ "tags": [ "functions" ], - "description": "Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.", + "description": "", "responses": { "200": { "description": "File", @@ -10791,12 +10867,12 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 292, + "weight": 378, "cookies": false, "type": "location", "deprecated": false, "demo": "functions\/get-deployment-download.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment-download.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10817,6 +10893,89 @@ "JWT": [] } ], + "parameters": [ + { + "name": "functionId", + "description": "Function ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": null, + "x-enum-keys": [], + "default": "source", + "in": "query" + } + ] + } + }, + "\/functions\/{functionId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "functionsUpdateDeploymentStatus", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } + } + }, + "x-appwrite": { + "method": "updateDeploymentStatus", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-deployment-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", + "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", @@ -10850,7 +11009,7 @@ "tags": [ "functions" ], - "description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.", + "description": "", "responses": { "200": { "description": "Executions List", @@ -10861,12 +11020,12 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 301, + "weight": 383, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-executions.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the current user function execution logs. You can use the query params to filter your results.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10932,7 +11091,7 @@ "tags": [ "functions" ], - "description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", + "description": "", "responses": { "201": { "description": "Execution", @@ -10943,12 +11102,12 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 300, + "weight": 381, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/create-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterTrigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11050,7 +11209,7 @@ "tags": [ "functions" ], - "description": "Get a function execution log by its unique ID.", + "description": "", "responses": { "200": { "description": "Execution", @@ -11061,12 +11220,12 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 302, + "weight": 382, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function execution log by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11117,7 +11276,7 @@ "tags": [ "functions" ], - "description": "Delete a function execution by its unique ID.\n", + "description": "", "responses": { "204": { "description": "No content" @@ -11125,12 +11284,12 @@ }, "x-appwrite": { "method": "deleteExecution", - "weight": 303, + "weight": 384, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function execution by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11172,7 +11331,7 @@ "\/functions\/{functionId}\/usage": { "get": { "summary": "Get function usage", - "operationId": "functionsGetFunctionUsage", + "operationId": "functionsGetUsage", "consumes": [ "application\/json" ], @@ -11182,7 +11341,7 @@ "tags": [ "functions" ], - "description": "Get usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", + "description": "", "responses": { "200": { "description": "UsageFunction", @@ -11192,13 +11351,13 @@ } }, "x-appwrite": { - "method": "getFunctionUsage", - "weight": 290, + "method": "getUsage", + "weight": 385, "cookies": false, "type": "", "deprecated": false, - "demo": "functions\/get-function-usage.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function-usage.md", + "demo": "functions\/get-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11261,7 +11420,7 @@ "tags": [ "functions" ], - "description": "Get a list of all variables of a specific function.", + "description": "", "responses": { "200": { "description": "Variables List", @@ -11272,12 +11431,12 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 305, + "weight": 389, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-variables.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all variables of a specific function.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11319,7 +11478,7 @@ "tags": [ "functions" ], - "description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.", + "description": "", "responses": { "201": { "description": "Variable", @@ -11330,12 +11489,12 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 304, + "weight": 387, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/create-variable.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new function environment variable. These variables can be accessed in the function at runtime as environment variables.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11397,6 +11556,231 @@ ] } }, + "\/functions\/{functionId}\/variables\/{variableId}": { + "get": { + "summary": "Get variable", + "operationId": "functionsGetVariable", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Variable", + "schema": { + "$ref": "#\/definitions\/variable" + } + } + }, + "x-appwrite": { + "method": "getVariable", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/get-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a variable by its unique ID.", + "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": "", + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update variable", + "operationId": "functionsUpdateVariable", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Variable", + "schema": { + "$ref": "#\/definitions\/variable" + } + } + }, + "x-appwrite": { + "method": "updateVariable", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate variable by its unique ID.", + "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": "", + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "default": null, + "x-example": "" + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.", + "default": null, + "x-example": false + } + }, + "required": [ + "key" + ] + } + } + ] + }, + "delete": { + "summary": "Delete variable", + "operationId": "functionsDeleteVariable", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteVariable", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/delete-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a variable by its unique ID.", + "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": "", + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, "\/graphql": { "post": { "summary": "GraphQL endpoint", @@ -11421,7 +11805,7 @@ }, "x-appwrite": { "method": "query", - "weight": 325, + "weight": 303, "cookies": false, "type": "graphql", "deprecated": false, @@ -11494,7 +11878,7 @@ }, "x-appwrite": { "method": "mutation", - "weight": 324, + "weight": 302, "cookies": false, "type": "graphql", "deprecated": false, @@ -11567,7 +11951,7 @@ }, "x-appwrite": { "method": "get", - "weight": 125, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -11617,7 +12001,7 @@ }, "x-appwrite": { "method": "getAntivirus", - "weight": 147, + "weight": 148, "cookies": false, "type": "", "deprecated": false, @@ -11667,7 +12051,7 @@ }, "x-appwrite": { "method": "getCache", - "weight": 128, + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -11717,7 +12101,7 @@ }, "x-appwrite": { "method": "getCertificate", - "weight": 133, + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -11776,7 +12160,7 @@ }, "x-appwrite": { "method": "getDB", - "weight": 127, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -11826,7 +12210,7 @@ }, "x-appwrite": { "method": "getPubSub", - "weight": 129, + "weight": 130, "cookies": false, "type": "", "deprecated": false, @@ -11876,7 +12260,7 @@ }, "x-appwrite": { "method": "getQueueBuilds", - "weight": 135, + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -11937,7 +12321,7 @@ }, "x-appwrite": { "method": "getQueueCertificates", - "weight": 134, + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -11998,7 +12382,7 @@ }, "x-appwrite": { "method": "getQueueDatabases", - "weight": 136, + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -12068,7 +12452,7 @@ }, "x-appwrite": { "method": "getQueueDeletes", - "weight": 137, + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -12129,7 +12513,7 @@ }, "x-appwrite": { "method": "getFailedJobs", - "weight": 148, + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -12215,7 +12599,7 @@ }, "x-appwrite": { "method": "getQueueFunctions", - "weight": 141, + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -12276,7 +12660,7 @@ }, "x-appwrite": { "method": "getQueueLogs", - "weight": 132, + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -12337,7 +12721,7 @@ }, "x-appwrite": { "method": "getQueueMails", - "weight": 138, + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -12398,7 +12782,7 @@ }, "x-appwrite": { "method": "getQueueMessaging", - "weight": 139, + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -12459,7 +12843,7 @@ }, "x-appwrite": { "method": "getQueueMigrations", - "weight": 140, + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -12520,7 +12904,7 @@ }, "x-appwrite": { "method": "getQueueStatsResources", - "weight": 142, + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -12581,7 +12965,7 @@ }, "x-appwrite": { "method": "getQueueUsage", - "weight": 143, + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -12642,7 +13026,7 @@ }, "x-appwrite": { "method": "getQueueStatsUsageDump", - "weight": 144, + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -12703,7 +13087,7 @@ }, "x-appwrite": { "method": "getQueueWebhooks", - "weight": 131, + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -12764,7 +13148,7 @@ }, "x-appwrite": { "method": "getStorage", - "weight": 146, + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -12814,7 +13198,7 @@ }, "x-appwrite": { "method": "getStorageLocal", - "weight": 145, + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -12864,7 +13248,7 @@ }, "x-appwrite": { "method": "getTime", - "weight": 130, + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -12914,7 +13298,7 @@ }, "x-appwrite": { "method": "get", - "weight": 117, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -12967,7 +13351,7 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 118, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -13020,7 +13404,7 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 122, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -13073,7 +13457,7 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 119, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -13126,7 +13510,7 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 120, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -13179,7 +13563,7 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 121, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -13232,7 +13616,7 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 123, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -13285,7 +13669,7 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 124, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -13338,7 +13722,7 @@ }, "x-appwrite": { "method": "listMessages", - "weight": 378, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -13412,7 +13796,7 @@ }, "x-appwrite": { "method": "createEmail", - "weight": 375, + "weight": 353, "cookies": false, "type": "", "deprecated": false, @@ -13569,7 +13953,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 382, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -13723,7 +14107,7 @@ }, "x-appwrite": { "method": "createPush", - "weight": 377, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -13917,7 +14301,7 @@ }, "x-appwrite": { "method": "updatePush", - "weight": 384, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -14110,7 +14494,7 @@ }, "x-appwrite": { "method": "createSms", - "weight": 376, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -14227,7 +14611,7 @@ }, "x-appwrite": { "method": "updateSms", - "weight": 383, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -14342,7 +14726,7 @@ }, "x-appwrite": { "method": "getMessage", - "weight": 381, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -14396,7 +14780,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 385, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -14457,7 +14841,7 @@ }, "x-appwrite": { "method": "listMessageLogs", - "weight": 379, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -14530,7 +14914,7 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 380, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -14603,7 +14987,7 @@ }, "x-appwrite": { "method": "listProviders", - "weight": 350, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -14677,7 +15061,7 @@ }, "x-appwrite": { "method": "createApnsProvider", - "weight": 349, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -14791,7 +15175,7 @@ }, "x-appwrite": { "method": "updateApnsProvider", - "weight": 362, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -14903,7 +15287,7 @@ }, "x-appwrite": { "method": "createFcmProvider", - "weight": 348, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -14993,7 +15377,7 @@ }, "x-appwrite": { "method": "updateFcmProvider", - "weight": 361, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -15081,7 +15465,7 @@ }, "x-appwrite": { "method": "createMailgunProvider", - "weight": 340, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -15207,7 +15591,7 @@ }, "x-appwrite": { "method": "updateMailgunProvider", - "weight": 353, + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -15331,7 +15715,7 @@ }, "x-appwrite": { "method": "createMsg91Provider", - "weight": 343, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -15433,7 +15817,7 @@ }, "x-appwrite": { "method": "updateMsg91Provider", - "weight": 356, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -15533,7 +15917,7 @@ }, "x-appwrite": { "method": "createSendgridProvider", - "weight": 341, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -15647,7 +16031,7 @@ }, "x-appwrite": { "method": "updateSendgridProvider", - "weight": 354, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -15759,7 +16143,7 @@ }, "x-appwrite": { "method": "createSmtpProvider", - "weight": 342, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -15917,7 +16301,7 @@ }, "x-appwrite": { "method": "updateSmtpProvider", - "weight": 355, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -16072,7 +16456,7 @@ }, "x-appwrite": { "method": "createTelesignProvider", - "weight": 344, + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -16174,7 +16558,7 @@ }, "x-appwrite": { "method": "updateTelesignProvider", - "weight": 357, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -16274,7 +16658,7 @@ }, "x-appwrite": { "method": "createTextmagicProvider", - "weight": 345, + "weight": 323, "cookies": false, "type": "", "deprecated": false, @@ -16376,7 +16760,7 @@ }, "x-appwrite": { "method": "updateTextmagicProvider", - "weight": 358, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -16476,7 +16860,7 @@ }, "x-appwrite": { "method": "createTwilioProvider", - "weight": 346, + "weight": 324, "cookies": false, "type": "", "deprecated": false, @@ -16578,7 +16962,7 @@ }, "x-appwrite": { "method": "updateTwilioProvider", - "weight": 359, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -16678,7 +17062,7 @@ }, "x-appwrite": { "method": "createVonageProvider", - "weight": 347, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -16780,7 +17164,7 @@ }, "x-appwrite": { "method": "updateVonageProvider", - "weight": 360, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -16880,7 +17264,7 @@ }, "x-appwrite": { "method": "getProvider", - "weight": 352, + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -16934,7 +17318,7 @@ }, "x-appwrite": { "method": "deleteProvider", - "weight": 363, + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -16995,7 +17379,7 @@ }, "x-appwrite": { "method": "listProviderLogs", - "weight": 351, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -17068,7 +17452,7 @@ }, "x-appwrite": { "method": "listSubscriberLogs", - "weight": 372, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -17141,7 +17525,7 @@ }, "x-appwrite": { "method": "listTopics", - "weight": 365, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -17213,7 +17597,7 @@ }, "x-appwrite": { "method": "createTopic", - "weight": 364, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -17302,7 +17686,7 @@ }, "x-appwrite": { "method": "getTopic", - "weight": 367, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -17361,7 +17745,7 @@ }, "x-appwrite": { "method": "updateTopic", - "weight": 368, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -17439,7 +17823,7 @@ }, "x-appwrite": { "method": "deleteTopic", - "weight": 369, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -17500,7 +17884,7 @@ }, "x-appwrite": { "method": "listTopicLogs", - "weight": 366, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -17573,7 +17957,7 @@ }, "x-appwrite": { "method": "listSubscribers", - "weight": 371, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -17653,7 +18037,7 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 370, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -17742,7 +18126,7 @@ }, "x-appwrite": { "method": "getSubscriber", - "weight": 373, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -17804,7 +18188,7 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 374, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -17876,7 +18260,7 @@ }, "x-appwrite": { "method": "list", - "weight": 332, + "weight": 310, "cookies": false, "type": "", "deprecated": false, @@ -17948,7 +18332,7 @@ }, "x-appwrite": { "method": "createAppwriteMigration", - "weight": 328, + "weight": 306, "cookies": false, "type": "", "deprecated": false, @@ -18041,7 +18425,7 @@ }, "x-appwrite": { "method": "getAppwriteReport", - "weight": 334, + "weight": 312, "cookies": false, "type": "", "deprecated": false, @@ -18128,7 +18512,7 @@ }, "x-appwrite": { "method": "createFirebaseMigration", - "weight": 329, + "weight": 307, "cookies": false, "type": "", "deprecated": false, @@ -18207,7 +18591,7 @@ }, "x-appwrite": { "method": "getFirebaseReport", - "weight": 335, + "weight": 313, "cookies": false, "type": "", "deprecated": false, @@ -18277,7 +18661,7 @@ }, "x-appwrite": { "method": "createNHostMigration", - "weight": 331, + "weight": 309, "cookies": false, "type": "", "deprecated": false, @@ -18397,7 +18781,7 @@ }, "x-appwrite": { "method": "getNHostReport", - "weight": 337, + "weight": 315, "cookies": false, "type": "", "deprecated": false, @@ -18516,7 +18900,7 @@ }, "x-appwrite": { "method": "createSupabaseMigration", - "weight": 330, + "weight": 308, "cookies": false, "type": "", "deprecated": false, @@ -18629,7 +19013,7 @@ }, "x-appwrite": { "method": "getSupabaseReport", - "weight": 336, + "weight": 314, "cookies": false, "type": "", "deprecated": false, @@ -18741,7 +19125,7 @@ }, "x-appwrite": { "method": "get", - "weight": 333, + "weight": 311, "cookies": false, "type": "", "deprecated": false, @@ -18798,7 +19182,7 @@ }, "x-appwrite": { "method": "retry", - "weight": 338, + "weight": 316, "cookies": false, "type": "", "deprecated": false, @@ -18850,7 +19234,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 339, + "weight": 317, "cookies": false, "type": "", "deprecated": false, @@ -18909,7 +19293,7 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 196, + "weight": 197, "cookies": false, "type": "", "deprecated": false, @@ -18992,7 +19376,7 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 198, + "weight": 199, "cookies": false, "type": "", "deprecated": false, @@ -19039,7 +19423,7 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 197, + "weight": 198, "cookies": false, "type": "", "deprecated": false, @@ -19121,7 +19505,7 @@ }, "x-appwrite": { "method": "getVariable", - "weight": 199, + "weight": 200, "cookies": false, "type": "", "deprecated": false, @@ -19178,7 +19562,7 @@ }, "x-appwrite": { "method": "updateVariable", - "weight": 200, + "weight": 201, "cookies": false, "type": "", "deprecated": false, @@ -19260,7 +19644,7 @@ }, "x-appwrite": { "method": "deleteVariable", - "weight": 201, + "weight": 202, "cookies": false, "type": "", "deprecated": false, @@ -19319,7 +19703,7 @@ }, "x-appwrite": { "method": "list", - "weight": 151, + "weight": 152, "cookies": false, "type": "", "deprecated": false, @@ -19389,7 +19773,7 @@ }, "x-appwrite": { "method": "create", - "weight": 150, + "weight": 151, "cookies": false, "type": "", "deprecated": false, @@ -19538,7 +19922,7 @@ }, "x-appwrite": { "method": "get", - "weight": 152, + "weight": 153, "cookies": false, "type": "", "deprecated": false, @@ -19595,7 +19979,7 @@ }, "x-appwrite": { "method": "update", - "weight": 153, + "weight": 154, "cookies": false, "type": "", "deprecated": false, @@ -19719,7 +20103,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 170, + "weight": 171, "cookies": false, "type": "", "deprecated": false, @@ -19778,7 +20162,7 @@ }, "x-appwrite": { "method": "updateApiStatus", - "weight": 157, + "weight": 158, "cookies": false, "type": "", "deprecated": false, @@ -19869,7 +20253,7 @@ }, "x-appwrite": { "method": "updateApiStatusAll", - "weight": 158, + "weight": 159, "cookies": false, "type": "", "deprecated": false, @@ -19946,7 +20330,7 @@ }, "x-appwrite": { "method": "updateAuthDuration", - "weight": 163, + "weight": 164, "cookies": false, "type": "", "deprecated": false, @@ -20023,7 +20407,7 @@ }, "x-appwrite": { "method": "updateAuthLimit", - "weight": 162, + "weight": 163, "cookies": false, "type": "", "deprecated": false, @@ -20100,7 +20484,7 @@ }, "x-appwrite": { "method": "updateAuthSessionsLimit", - "weight": 168, + "weight": 169, "cookies": false, "type": "", "deprecated": false, @@ -20177,7 +20561,7 @@ }, "x-appwrite": { "method": "updateMembershipsPrivacy", - "weight": 161, + "weight": 162, "cookies": false, "type": "", "deprecated": false, @@ -20268,7 +20652,7 @@ }, "x-appwrite": { "method": "updateMockNumbers", - "weight": 169, + "weight": 170, "cookies": false, "type": "", "deprecated": false, @@ -20348,7 +20732,7 @@ }, "x-appwrite": { "method": "updateAuthPasswordDictionary", - "weight": 166, + "weight": 167, "cookies": false, "type": "", "deprecated": false, @@ -20425,7 +20809,7 @@ }, "x-appwrite": { "method": "updateAuthPasswordHistory", - "weight": 165, + "weight": 166, "cookies": false, "type": "", "deprecated": false, @@ -20502,7 +20886,7 @@ }, "x-appwrite": { "method": "updatePersonalDataCheck", - "weight": 167, + "weight": 168, "cookies": false, "type": "", "deprecated": false, @@ -20579,7 +20963,7 @@ }, "x-appwrite": { "method": "updateSessionAlerts", - "weight": 160, + "weight": 161, "cookies": false, "type": "", "deprecated": false, @@ -20656,7 +21040,7 @@ }, "x-appwrite": { "method": "updateAuthStatus", - "weight": 164, + "weight": 165, "cookies": false, "type": "", "deprecated": false, @@ -20752,7 +21136,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 182, + "weight": 183, "cookies": false, "type": "", "deprecated": false, @@ -20838,7 +21222,7 @@ }, "x-appwrite": { "method": "listKeys", - "weight": 178, + "weight": 179, "cookies": false, "type": "", "deprecated": false, @@ -20895,7 +21279,7 @@ }, "x-appwrite": { "method": "createKey", - "weight": 177, + "weight": 178, "cookies": false, "type": "", "deprecated": false, @@ -20988,7 +21372,7 @@ }, "x-appwrite": { "method": "getKey", - "weight": 179, + "weight": 180, "cookies": false, "type": "", "deprecated": false, @@ -21053,7 +21437,7 @@ }, "x-appwrite": { "method": "updateKey", - "weight": 180, + "weight": 181, "cookies": false, "type": "", "deprecated": false, @@ -21147,7 +21531,7 @@ }, "x-appwrite": { "method": "deleteKey", - "weight": 181, + "weight": 182, "cookies": false, "type": "", "deprecated": false, @@ -21214,7 +21598,7 @@ }, "x-appwrite": { "method": "updateOAuth2", - "weight": 159, + "weight": 160, "cookies": false, "type": "", "deprecated": false, @@ -21352,7 +21736,7 @@ }, "x-appwrite": { "method": "listPlatforms", - "weight": 184, + "weight": 185, "cookies": false, "type": "", "deprecated": false, @@ -21409,7 +21793,7 @@ }, "x-appwrite": { "method": "createPlatform", - "weight": 183, + "weight": 184, "cookies": false, "type": "", "deprecated": false, @@ -21530,7 +21914,7 @@ }, "x-appwrite": { "method": "getPlatform", - "weight": 185, + "weight": 186, "cookies": false, "type": "", "deprecated": false, @@ -21595,7 +21979,7 @@ }, "x-appwrite": { "method": "updatePlatform", - "weight": 186, + "weight": 187, "cookies": false, "type": "", "deprecated": false, @@ -21691,7 +22075,7 @@ }, "x-appwrite": { "method": "deletePlatform", - "weight": 187, + "weight": 188, "cookies": false, "type": "", "deprecated": false, @@ -21758,7 +22142,7 @@ }, "x-appwrite": { "method": "updateServiceStatus", - "weight": 155, + "weight": 156, "cookies": false, "type": "", "deprecated": false, @@ -21858,7 +22242,7 @@ }, "x-appwrite": { "method": "updateServiceStatusAll", - "weight": 156, + "weight": 157, "cookies": false, "type": "", "deprecated": false, @@ -21935,7 +22319,7 @@ }, "x-appwrite": { "method": "updateSmtp", - "weight": 188, + "weight": 189, "cookies": false, "type": "", "deprecated": false, @@ -22063,7 +22447,7 @@ }, "x-appwrite": { "method": "createSmtpTest", - "weight": 189, + "weight": 190, "cookies": false, "type": "", "deprecated": false, @@ -22200,7 +22584,7 @@ }, "x-appwrite": { "method": "updateTeam", - "weight": 154, + "weight": 155, "cookies": false, "type": "", "deprecated": false, @@ -22277,7 +22661,7 @@ }, "x-appwrite": { "method": "getEmailTemplate", - "weight": 191, + "weight": 192, "cookies": false, "type": "", "deprecated": false, @@ -22496,7 +22880,7 @@ }, "x-appwrite": { "method": "updateEmailTemplate", - "weight": 193, + "weight": 194, "cookies": false, "type": "", "deprecated": false, @@ -22758,7 +23142,7 @@ }, "x-appwrite": { "method": "deleteEmailTemplate", - "weight": 195, + "weight": 196, "cookies": false, "type": "", "deprecated": false, @@ -22979,7 +23363,7 @@ }, "x-appwrite": { "method": "getSmsTemplate", - "weight": 190, + "weight": 191, "cookies": false, "type": "", "deprecated": false, @@ -23195,7 +23579,7 @@ }, "x-appwrite": { "method": "updateSmsTemplate", - "weight": 192, + "weight": 193, "cookies": false, "type": "", "deprecated": false, @@ -23429,7 +23813,7 @@ }, "x-appwrite": { "method": "deleteSmsTemplate", - "weight": 194, + "weight": 195, "cookies": false, "type": "", "deprecated": false, @@ -23647,7 +24031,7 @@ }, "x-appwrite": { "method": "listWebhooks", - "weight": 172, + "weight": 173, "cookies": false, "type": "", "deprecated": false, @@ -23704,7 +24088,7 @@ }, "x-appwrite": { "method": "createWebhook", - "weight": 171, + "weight": 172, "cookies": false, "type": "", "deprecated": false, @@ -23823,7 +24207,7 @@ }, "x-appwrite": { "method": "getWebhook", - "weight": 173, + "weight": 174, "cookies": false, "type": "", "deprecated": false, @@ -23888,7 +24272,7 @@ }, "x-appwrite": { "method": "updateWebhook", - "weight": 174, + "weight": 175, "cookies": false, "type": "", "deprecated": false, @@ -24008,7 +24392,7 @@ }, "x-appwrite": { "method": "deleteWebhook", - "weight": 176, + "weight": 177, "cookies": false, "type": "", "deprecated": false, @@ -24075,7 +24459,7 @@ }, "x-appwrite": { "method": "updateWebhookSignature", - "weight": 175, + "weight": 176, "cookies": false, "type": "", "deprecated": false, @@ -24142,7 +24526,7 @@ }, "x-appwrite": { "method": "listRules", - "weight": 311, + "weight": 289, "cookies": false, "type": "", "deprecated": false, @@ -24168,7 +24552,7 @@ "parameters": [ { "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, value, automation, url", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch", "required": false, "type": "array", "collectionFormat": "multi", @@ -24214,7 +24598,7 @@ }, "x-appwrite": { "method": "createAPIRule", - "weight": 423, + "weight": 424, "cookies": false, "type": "", "deprecated": false, @@ -24283,7 +24667,7 @@ }, "x-appwrite": { "method": "createFunctionRule", - "weight": 425, + "weight": 426, "cookies": false, "type": "", "deprecated": false, @@ -24365,7 +24749,7 @@ }, "x-appwrite": { "method": "createRedirectRule", - "weight": 426, + "weight": 427, "cookies": false, "type": "", "deprecated": false, @@ -24401,16 +24785,31 @@ "default": null, "x-example": null }, - "target": { + "url": { "type": "string", - "description": "Target domain (hostname) of redirection", + "description": "Target URL of redirection", "default": null, - "x-example": null + "x-example": "https:\/\/example.com" + }, + "statusCode": { + "type": "string", + "description": "Status code of redirection", + "default": null, + "x-example": "301", + "enum": [ + "301", + "302", + "307", + "308" + ], + "x-enum-name": null, + "x-enum-keys": [] } }, "required": [ "domain", - "target" + "url", + "statusCode" ] } } @@ -24441,7 +24840,7 @@ }, "x-appwrite": { "method": "createSiteRule", - "weight": 424, + "weight": 425, "cookies": false, "type": "", "deprecated": false, @@ -24523,7 +24922,7 @@ }, "x-appwrite": { "method": "getRule", - "weight": 312, + "weight": 290, "cookies": false, "type": "", "deprecated": false, @@ -24575,7 +24974,7 @@ }, "x-appwrite": { "method": "deleteRule", - "weight": 313, + "weight": 291, "cookies": false, "type": "", "deprecated": false, @@ -24634,7 +25033,7 @@ }, "x-appwrite": { "method": "updateRuleVerification", - "weight": 314, + "weight": 292, "cookies": false, "type": "", "deprecated": false, @@ -24693,7 +25092,7 @@ }, "x-appwrite": { "method": "list", - "weight": 395, + "weight": 396, "cookies": false, "type": "", "deprecated": false, @@ -24764,7 +25163,7 @@ }, "x-appwrite": { "method": "create", - "weight": 393, + "weight": 394, "cookies": false, "type": "", "deprecated": false, @@ -24922,8 +25321,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -25018,7 +25416,7 @@ }, "x-appwrite": { "method": "listFrameworks", - "weight": 398, + "weight": 399, "cookies": false, "type": "", "deprecated": false, @@ -25044,6 +25442,57 @@ ] } }, + "\/sites\/specifications": { + "get": { + "summary": "List specifications", + "operationId": "sitesListSpecifications", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Specifications List", + "schema": { + "$ref": "#\/definitions\/specificationList" + } + } + }, + "x-appwrite": { + "method": "listSpecifications", + "weight": 422, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/list-specifications.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed site specifications for this instance.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.read", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, "\/sites\/templates": { "get": { "summary": "List templates", @@ -25289,7 +25738,7 @@ }, "x-appwrite": { "method": "get", - "weight": 394, + "weight": 395, "cookies": false, "type": "", "deprecated": false, @@ -25347,7 +25796,7 @@ }, "x-appwrite": { "method": "update", - "weight": 396, + "weight": 397, "cookies": false, "type": "", "deprecated": false, @@ -25507,8 +25956,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -25594,7 +26042,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 397, + "weight": 398, "cookies": false, "type": "", "deprecated": false, @@ -25630,6 +26078,84 @@ ] } }, + "\/sites\/{siteId}\/deployment": { + "patch": { + "summary": "Update site's deployment", + "operationId": "sitesUpdateSiteDeployment", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Site", + "schema": { + "$ref": "#\/definitions\/site" + } + } + }, + "x-appwrite": { + "method": "updateSiteDeployment", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/update-site-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + ] + } + }, "\/sites\/{siteId}\/deployments": { "get": { "summary": "List deployments", @@ -25654,7 +26180,7 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 403, + "weight": 404, "cookies": false, "type": "", "deprecated": false, @@ -25689,7 +26215,7 @@ }, { "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", + "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: buildSize, sourceSize, buildDuration, status, activate, type", "required": false, "type": "array", "collectionFormat": "multi", @@ -25733,7 +26259,7 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 399, + "weight": 400, "cookies": false, "type": "upload", "deprecated": false, @@ -25808,6 +26334,84 @@ ] } }, + "\/sites\/{siteId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "sitesCreateDuplicateDeployment", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "", + "responses": { + "202": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } + } + }, + "x-appwrite": { + "method": "createDuplicateDeployment", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/create-duplicate-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands 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.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + ] + } + }, "\/sites\/{siteId}\/deployments\/template": { "post": { "summary": "Create deployment", @@ -25832,7 +26436,7 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 400, + "weight": 401, "cookies": false, "type": "", "deprecated": false, @@ -25937,7 +26541,7 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 401, + "weight": 402, "cookies": false, "type": "", "deprecated": false, @@ -26033,7 +26637,7 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 402, + "weight": 403, "cookies": false, "type": "", "deprecated": false, @@ -26076,72 +26680,6 @@ } ] }, - "patch": { - "summary": "Update deployment", - "operationId": "sitesUpdateDeployment", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "Function", - "schema": { - "$ref": "#\/definitions\/function" - } - } - }, - "x-appwrite": { - "method": "updateDeployment", - "weight": 404, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/update-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, "delete": { "summary": "Delete deployment", "operationId": "sitesDeleteDeployment", @@ -26160,7 +26698,7 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 405, + "weight": 406, "cookies": false, "type": "", "deprecated": false, @@ -26204,207 +26742,6 @@ ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/build": { - "post": { - "summary": "Rebuild deployment", - "operationId": "sitesCreateDeploymentBuild", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "", - "responses": { - "204": { - "description": "No content" - } - }, - "x-appwrite": { - "method": "createDeploymentBuild", - "weight": 408, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/create-deployment-build.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands 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.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "patch": { - "summary": "Cancel deployment", - "operationId": "sitesUpdateDeploymentBuild", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "Build", - "schema": { - "$ref": "#\/definitions\/build" - } - } - }, - "x-appwrite": { - "method": "updateDeploymentBuild", - "weight": 409, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/update-deployment-build.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/build\/download": { - "get": { - "summary": "Download build", - "operationId": "sitesGetDeploymentBuildDownload", - "consumes": [ - "application\/json" - ], - "produces": [ - "*\/*" - ], - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "File", - "schema": { - "type": "file" - } - } - }, - "x-appwrite": { - "method": "getDeploymentBuildDownload", - "weight": 407, - "cookies": false, - "type": "location", - "deprecated": false, - "demo": "sites\/get-deployment-build-download.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site build content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { "get": { "summary": "Download deployment", @@ -26429,7 +26766,7 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 406, + "weight": 407, "cookies": false, "type": "location", "deprecated": false, @@ -26455,6 +26792,89 @@ "JWT": [] } ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [], + "default": "source", + "in": "query" + } + ] + } + }, + "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "sitesUpdateDeploymentStatus", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } + } + }, + "x-appwrite": { + "method": "updateDeploymentStatus", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/update-deployment-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", + "platforms": [ + "server" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], "parameters": [ { "name": "siteId", @@ -27164,7 +27584,7 @@ }, "x-appwrite": { "method": "listBuckets", - "weight": 203, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -27235,7 +27655,7 @@ }, "x-appwrite": { "method": "createBucket", - "weight": 202, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -27373,7 +27793,7 @@ }, "x-appwrite": { "method": "getBucket", - "weight": 204, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -27431,7 +27851,7 @@ }, "x-appwrite": { "method": "updateBucket", - "weight": 205, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -27563,7 +27983,7 @@ }, "x-appwrite": { "method": "deleteBucket", - "weight": 206, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -27623,7 +28043,7 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 208, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -27705,7 +28125,7 @@ }, "x-appwrite": { "method": "createFile", - "weight": 207, + "weight": 208, "cookies": false, "type": "upload", "deprecated": false, @@ -27796,7 +28216,7 @@ }, "x-appwrite": { "method": "getFile", - "weight": 209, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -27865,7 +28285,7 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 214, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -27953,7 +28373,7 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 215, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -28024,7 +28444,7 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 211, + "weight": 212, "cookies": false, "type": "location", "deprecated": false, @@ -28095,7 +28515,7 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 210, + "weight": 211, "cookies": false, "type": "location", "deprecated": false, @@ -28294,7 +28714,7 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 212, + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -28365,7 +28785,7 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 216, + "weight": 217, "cookies": false, "type": "", "deprecated": false, @@ -28436,7 +28856,7 @@ }, "x-appwrite": { "method": "getBucketUsage", - "weight": 217, + "weight": 218, "cookies": false, "type": "", "deprecated": false, @@ -28515,7 +28935,7 @@ }, "x-appwrite": { "method": "list", - "weight": 219, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -28589,7 +29009,7 @@ }, "x-appwrite": { "method": "create", - "weight": 218, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -28680,7 +29100,7 @@ }, "x-appwrite": { "method": "get", - "weight": 220, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -28741,7 +29161,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 222, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -28815,7 +29235,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 224, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -28878,7 +29298,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 231, + "weight": 232, "cookies": false, "type": "", "deprecated": false, @@ -28949,7 +29369,7 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 226, + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -29031,7 +29451,7 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 225, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -29145,7 +29565,7 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 227, + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -29214,7 +29634,7 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 228, + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -29299,7 +29719,7 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 230, + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -29370,7 +29790,7 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 229, + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -29464,7 +29884,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 221, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -29523,7 +29943,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 223, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -29602,7 +30022,7 @@ }, "x-appwrite": { "method": "list", - "weight": 241, + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -29673,7 +30093,7 @@ }, "x-appwrite": { "method": "create", - "weight": 232, + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -29767,7 +30187,7 @@ }, "x-appwrite": { "method": "createArgon2User", - "weight": 235, + "weight": 236, "cookies": false, "type": "", "deprecated": false, @@ -29857,7 +30277,7 @@ }, "x-appwrite": { "method": "createBcryptUser", - "weight": 233, + "weight": 234, "cookies": false, "type": "", "deprecated": false, @@ -29947,7 +30367,7 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 249, + "weight": 250, "cookies": false, "type": "", "deprecated": false, @@ -30015,7 +30435,7 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 272, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -30075,7 +30495,7 @@ }, "x-appwrite": { "method": "createMD5User", - "weight": 234, + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -30165,7 +30585,7 @@ }, "x-appwrite": { "method": "createPHPassUser", - "weight": 237, + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -30255,7 +30675,7 @@ }, "x-appwrite": { "method": "createScryptUser", - "weight": 238, + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -30380,7 +30800,7 @@ }, "x-appwrite": { "method": "createScryptModifiedUser", - "weight": 239, + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -30491,7 +30911,7 @@ }, "x-appwrite": { "method": "createSHAUser", - "weight": 236, + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -30602,7 +31022,7 @@ }, "x-appwrite": { "method": "getUsage", - "weight": 274, + "weight": 275, "cookies": false, "type": "", "deprecated": false, @@ -30673,7 +31093,7 @@ }, "x-appwrite": { "method": "get", - "weight": 242, + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -30726,7 +31146,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 270, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -30786,7 +31206,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 255, + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -30864,7 +31284,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 273, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -30945,7 +31365,7 @@ }, "x-appwrite": { "method": "updateLabels", - "weight": 251, + "weight": 252, "cookies": false, "type": "", "deprecated": false, @@ -31026,7 +31446,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 247, + "weight": 248, "cookies": false, "type": "", "deprecated": false, @@ -31098,7 +31518,7 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 246, + "weight": 247, "cookies": false, "type": "", "deprecated": false, @@ -31158,7 +31578,7 @@ }, "x-appwrite": { "method": "updateMfa", - "weight": 260, + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -31231,7 +31651,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 265, + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -31304,7 +31724,7 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 261, + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -31364,7 +31784,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 262, + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -31422,7 +31842,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 264, + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -31480,7 +31900,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 263, + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -31540,7 +31960,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 253, + "weight": 254, "cookies": false, "type": "", "deprecated": false, @@ -31618,7 +32038,7 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 254, + "weight": 255, "cookies": false, "type": "", "deprecated": false, @@ -31696,7 +32116,7 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 256, + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -31774,7 +32194,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 243, + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -31832,7 +32252,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 258, + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -31910,7 +32330,7 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 245, + "weight": 246, "cookies": false, "type": "", "deprecated": false, @@ -31968,7 +32388,7 @@ }, "x-appwrite": { "method": "createSession", - "weight": 266, + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -32021,7 +32441,7 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 269, + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -32076,7 +32496,7 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 268, + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -32144,7 +32564,7 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 250, + "weight": 251, "cookies": false, "type": "", "deprecated": false, @@ -32222,7 +32642,7 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 248, + "weight": 249, "cookies": false, "type": "", "deprecated": false, @@ -32293,7 +32713,7 @@ }, "x-appwrite": { "method": "createTarget", - "weight": 240, + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -32405,7 +32825,7 @@ }, "x-appwrite": { "method": "getTarget", - "weight": 244, + "weight": 245, "cookies": false, "type": "", "deprecated": false, @@ -32472,7 +32892,7 @@ }, "x-appwrite": { "method": "updateTarget", - "weight": 259, + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -32561,7 +32981,7 @@ }, "x-appwrite": { "method": "deleteTarget", - "weight": 271, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -32630,7 +33050,7 @@ }, "x-appwrite": { "method": "createToken", - "weight": 267, + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -32711,7 +33131,7 @@ }, "x-appwrite": { "method": "updateEmailVerification", - "weight": 257, + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -32789,7 +33209,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 252, + "weight": 253, "cookies": false, "type": "", "deprecated": false, @@ -32843,6 +33263,102 @@ ] } }, + "\/vcs\/github\/installations\/{installationId}\/detections": { + "post": { + "summary": "Create repository detection", + "operationId": "vcsCreateRepositoryDetection", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "vcs" + ], + "description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", + "responses": { + "200": { + "description": "DetectionFramework", + "schema": { + "$ref": "#\/definitions\/detectionFramework" + } + } + }, + "x-appwrite": { + "method": "createRepositoryDetection", + "weight": 279, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "vcs\/create-repository-detection.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository-detection.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "vcs.write", + "platforms": [ + "console" + ], + "packaging": false, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "installationId", + "description": "Installation Id", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "providerRepositoryId": { + "type": "string", + "description": "Repository Id", + "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Detector type. Must be one of the following: runtime, framework", + "default": null, + "x-example": "runtime", + "enum": [ + "runtime", + "framework" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to Root Directory", + "default": "", + "x-example": "" + } + }, + "required": [ + "providerRepositoryId", + "type" + ] + } + } + ] + } + }, "\/vcs\/github\/installations\/{installationId}\/providerRepositories": { "get": { "summary": "List repositories", @@ -32859,15 +33375,15 @@ "description": "Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.", "responses": { "200": { - "description": "Provider Repositories List", + "description": "Framework Provider Repositories List", "schema": { - "$ref": "#\/definitions\/providerRepositoryList" + "$ref": "#\/definitions\/providerRepositoryFrameworkList" } } }, "x-appwrite": { "method": "listRepositories", - "weight": 279, + "weight": 280, "cookies": false, "type": "", "deprecated": false, @@ -32899,6 +33415,20 @@ "x-example": "", "in": "path" }, + { + "name": "type", + "description": "Detector type. Must be one of the following: runtime, framework", + "required": true, + "type": "string", + "x-example": "runtime", + "enum": [ + "runtime", + "framework" + ], + "x-enum-name": null, + "x-enum-keys": [], + "in": "query" + }, { "name": "search", "description": "Search term to filter your list results. Max length: 256 chars.", @@ -32933,7 +33463,7 @@ }, "x-appwrite": { "method": "createRepository", - "weight": 280, + "weight": 281, "cookies": false, "type": "", "deprecated": false, @@ -33017,7 +33547,7 @@ }, "x-appwrite": { "method": "getRepository", - "weight": 281, + "weight": 282, "cookies": false, "type": "", "deprecated": false, @@ -33084,7 +33614,7 @@ }, "x-appwrite": { "method": "listRepositoryBranches", - "weight": 282, + "weight": 283, "cookies": false, "type": "", "deprecated": false, @@ -33151,7 +33681,7 @@ }, "x-appwrite": { "method": "getRepositoryContents", - "weight": 277, + "weight": 278, "cookies": false, "type": "", "deprecated": false, @@ -33203,88 +33733,6 @@ ] } }, - "\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/detection": { - "post": { - "summary": "Detect runtime settings from source code", - "operationId": "vcsCreateRepositoryDetection", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "vcs" - ], - "description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.", - "responses": { - "200": { - "description": "Detection", - "schema": { - "$ref": "#\/definitions\/detection" - } - } - }, - "x-appwrite": { - "method": "createRepositoryDetection", - "weight": 278, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "vcs\/create-repository-detection.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository-detection.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "vcs.write", - "platforms": [ - "console" - ], - "packaging": false, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "installationId", - "description": "Installation Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "providerRepositoryId", - "description": "Repository Id", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "providerRootDirectory": { - "type": "string", - "description": "Path to Root Directory", - "default": "", - "x-example": "" - } - } - } - } - ] - } - }, "\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}": { "patch": { "summary": "Authorize external deployment", @@ -33306,7 +33754,7 @@ }, "x-appwrite": { "method": "updateExternalDeployments", - "weight": 287, + "weight": 288, "cookies": false, "type": "", "deprecated": false, @@ -33391,7 +33839,7 @@ }, "x-appwrite": { "method": "listInstallations", - "weight": 284, + "weight": 285, "cookies": false, "type": "", "deprecated": false, @@ -33463,7 +33911,7 @@ }, "x-appwrite": { "method": "getInstallation", - "weight": 285, + "weight": 286, "cookies": false, "type": "", "deprecated": false, @@ -33515,7 +33963,7 @@ }, "x-appwrite": { "method": "deleteInstallation", - "weight": 286, + "weight": 287, "cookies": false, "type": "", "deprecated": false, @@ -34071,29 +34519,54 @@ "installations" ] }, - "providerRepositoryList": { - "description": "Provider Repositories List", + "providerRepositoryFrameworkList": { + "description": "Framework Provider Repositories List", "type": "object", "properties": { "total": { "type": "integer", - "description": "Total number of providerRepositories documents that matched your query.", + "description": "Total number of frameworkProviderRepositories documents that matched your query.", "x-example": 5, "format": "int32" }, - "providerRepositories": { + "frameworkProviderRepositories": { "type": "array", - "description": "List of providerRepositories.", + "description": "List of frameworkProviderRepositories.", "items": { "type": "object", - "$ref": "#\/definitions\/providerRepository" + "$ref": "#\/definitions\/providerRepositoryFramework" }, "x-example": "" } }, "required": [ "total", - "providerRepositories" + "frameworkProviderRepositories" + ] + }, + "providerRepositoryRuntimeList": { + "description": "Runtime Provider Repositories List", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of runtimeProviderRepositories documents that matched your query.", + "x-example": 5, + "format": "int32" + }, + "runtimeProviderRepositories": { + "type": "array", + "description": "List of runtimeProviderRepositories.", + "items": { + "type": "object", + "$ref": "#\/definitions\/providerRepositoryRuntime" + }, + "x-example": "" + } + }, + "required": [ + "total", + "runtimeProviderRepositories" ] }, "branchList": { @@ -37094,10 +37567,15 @@ "description": "URL hosting a template demo.", "x-example": "https:\/\/nextjs-starter.appwrite.network\/" }, - "demoImage": { + "screenshotDark": { "type": "string", - "description": "File URL with preview screenshot.", - "x-example": "https:\/\/cloud.appwrite.io\/console\/images\/sites\/templates\/nextjs-starter.png" + "description": "File URL with preview screenshot in dark theme preference.", + "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png" + }, + "screenshotLight": { + "type": "string", + "description": "File URL with preview screenshot in light theme preference.", + "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png" }, "useCases": { "type": "array", @@ -37150,7 +37628,8 @@ "key", "name", "demoUrl", - "demoImage", + "screenshotDark", + "screenshotLight", "useCases", "frameworks", "vcsProvider", @@ -37674,11 +38153,6 @@ "description": "Is VCS (Version Control System) repository private?", "x-example": true }, - "runtime": { - "type": "string", - "description": "Auto-detected runtime suggestion. Empty if getting response of getRuntime().", - "x-example": "node" - }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", @@ -37691,22 +38165,165 @@ "organization", "provider", "private", - "runtime", "pushedAt" ] }, - "detection": { - "description": "Detection", + "providerRepositoryFramework": { + "description": "ProviderRepositoryFramework", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "VCS (Version Control System) repository ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "VCS (Version Control System) repository name.", + "x-example": "appwrite" + }, + "organization": { + "type": "string", + "description": "VCS (Version Control System) organization name", + "x-example": "appwrite" + }, + "provider": { + "type": "string", + "description": "VCS (Version Control System) provider name.", + "x-example": "github" + }, + "private": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository private?", + "x-example": true + }, + "pushedAt": { + "type": "string", + "description": "Last commit date in ISO 8601 format.", + "x-example": "datetime" + }, + "framework": { + "type": "string", + "description": "Auto-detected framework. Empty if type is not \"framework\".", + "x-example": "nextjs" + } + }, + "required": [ + "id", + "name", + "organization", + "provider", + "private", + "pushedAt", + "framework" + ] + }, + "providerRepositoryRuntime": { + "description": "ProviderRepositoryRuntime", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "VCS (Version Control System) repository ID.", + "x-example": "5e5ea5c16897e" + }, + "name": { + "type": "string", + "description": "VCS (Version Control System) repository name.", + "x-example": "appwrite" + }, + "organization": { + "type": "string", + "description": "VCS (Version Control System) organization name", + "x-example": "appwrite" + }, + "provider": { + "type": "string", + "description": "VCS (Version Control System) provider name.", + "x-example": "github" + }, + "private": { + "type": "boolean", + "description": "Is VCS (Version Control System) repository private?", + "x-example": true + }, + "pushedAt": { + "type": "string", + "description": "Last commit date in ISO 8601 format.", + "x-example": "datetime" + }, + "runtime": { + "type": "string", + "description": "Auto-detected runtime. Empty if type is not \"runtime\".", + "x-example": "node-22" + } + }, + "required": [ + "id", + "name", + "organization", + "provider", + "private", + "pushedAt", + "runtime" + ] + }, + "detectionFramework": { + "description": "DetectionFramework", + "type": "object", + "properties": { + "framework": { + "type": "string", + "description": "Framework", + "x-example": "nuxt" + }, + "installCommand": { + "type": "string", + "description": "Site Install Command", + "x-example": "npm install" + }, + "buildCommand": { + "type": "string", + "description": "Site Build Command", + "x-example": "npm run build" + }, + "outputDirectory": { + "type": "string", + "description": "Site Output Directory", + "x-example": "dist" + } + }, + "required": [ + "framework", + "installCommand", + "buildCommand", + "outputDirectory" + ] + }, + "detectionRuntime": { + "description": "DetectionRuntime", "type": "object", "properties": { "runtime": { "type": "string", "description": "Runtime", "x-example": "node" + }, + "entrypoint": { + "type": "string", + "description": "Function Entrypoint", + "x-example": "index.js" + }, + "commands": { + "type": "string", + "description": "Function install and build commands", + "x-example": "npm install && npm run build" } }, "required": [ - "runtime" + "runtime", + "entrypoint", + "commands" ] }, "vcsContent": { @@ -37936,7 +38553,7 @@ "description": "The entrypoint file to use to execute the deployment code.", "x-example": "index.js" }, - "size": { + "sourceSize": { "type": "integer", "description": "The code size in bytes.", "x-example": 128, @@ -37978,7 +38595,7 @@ "description": "The build logs.", "x-example": "Compiling source files..." }, - "buildTime": { + "buildDuration": { "type": "integer", "description": "The current build time in seconds.", "x-example": 128, @@ -38043,7 +38660,7 @@ "resourceId", "resourceType", "entrypoint", - "size", + "sourceSize", "buildSize", "buildId", "activate", @@ -38051,7 +38668,7 @@ "screenshotDark", "status", "buildLogs", - "buildTime", + "buildDuration", "providerRepositoryName", "providerRepositoryOwner", "providerRepositoryUrl", @@ -38197,70 +38814,6 @@ "duration" ] }, - "build": { - "description": "Build", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Build ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentId": { - "type": "string", - "description": "The deployment that created this build.", - "x-example": "5e5ea5c16897e" - }, - "status": { - "type": "string", - "description": "The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built", - "x-example": "ready" - }, - "stdout": { - "type": "string", - "description": "The stdout of the build.", - "x-example": "" - }, - "stderr": { - "type": "string", - "description": "The stderr of the build.", - "x-example": "" - }, - "startTime": { - "type": "string", - "description": "The deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "endTime": { - "type": "string", - "description": "The time the build was finished in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "duration": { - "type": "integer", - "description": "The build duration in seconds.", - "x-example": 0, - "format": "int32" - }, - "size": { - "type": "integer", - "description": "The code size in bytes.", - "x-example": 128, - "format": "int32" - } - }, - "required": [ - "$id", - "deploymentId", - "status", - "stdout", - "stderr", - "startTime", - "endTime", - "duration", - "size" - ] - }, "project": { "description": "Project", "type": "object", @@ -40667,15 +41220,41 @@ "description": "Action definition for the rule. Possible values are \"api\", \"deployment\", or \"redirect\"", "x-example": "deployment" }, - "value": { + "trigger": { "type": "string", - "description": "Detail specification for the type. If type is \"api\", this is empty. If type is \"redirect\", this is URL. If type is \"deployment\", this is deployment ID.", - "x-example": "67a9cf1a00150ee93abd" + "description": "Defines how the rule was created. Possible values are \"manual\" or \"deployment\"", + "x-example": "manual" }, - "automation": { + "redirectUrl": { "type": "string", - "description": "Action that results in a rule update. If VCS branch, value can be of syntax \"branch=[name]\"", - "x-example": "branch=dev" + "description": "URL to redirect to. Used if type is \"redirect\"", + "x-example": "https:\/\/appwrite.io\/docs" + }, + "redirectStatusCode": { + "type": "integer", + "description": "Status code to apply during redirect. Used if type is \"redirect\"", + "x-example": 301, + "format": "int32" + }, + "deploymentId": { + "type": "string", + "description": "ID of deployment. Used if type is \"deployment\"", + "x-example": "n3u9feiwmf" + }, + "deploymentResourceType": { + "type": "string", + "description": "Type of deployment. Possible values are \"function\", \"site\". Used if rule's type is \"deployment\".", + "x-example": "function" + }, + "deploymentResourceId": { + "type": "string", + "description": "ID deployment's resource. Used if type is \"deployment\"", + "x-example": "n3u9feiwmf" + }, + "deploymentVcsProviderBranch": { + "type": "string", + "description": "Name of Git branch that updates rule. Used if type is \"deployment\"", + "x-example": "function" }, "status": { "type": "string", @@ -40699,8 +41278,13 @@ "$updatedAt", "domain", "type", - "value", - "automation", + "trigger", + "redirectUrl", + "redirectStatusCode", + "deploymentId", + "deploymentResourceType", + "deploymentResourceId", + "deploymentVcsProviderBranch", "status", "logs", "renewAt" diff --git a/app/config/specs/swagger2-latest-server.json b/app/config/specs/swagger2-latest-server.json index 8d7586da05..e02fb26e05 100644 --- a/app/config/specs/swagger2-latest-server.json +++ b/app/config/specs/swagger2-latest-server.json @@ -102,7 +102,7 @@ }, "x-appwrite": { "method": "get", - "weight": 9, + "weight": 10, "cookies": false, "type": "", "deprecated": false, @@ -153,7 +153,7 @@ }, "x-appwrite": { "method": "create", - "weight": 8, + "weight": 9, "cookies": false, "type": "", "deprecated": false, @@ -243,7 +243,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 34, + "weight": 35, "cookies": false, "type": "", "deprecated": false, @@ -323,7 +323,7 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 57, + "weight": 58, "cookies": false, "type": "", "deprecated": false, @@ -385,7 +385,7 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 58, + "weight": 59, "cookies": false, "type": "", "deprecated": false, @@ -448,7 +448,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 29, + "weight": 30, "cookies": false, "type": "", "deprecated": false, @@ -498,7 +498,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 31, + "weight": 32, "cookies": false, "type": "", "deprecated": false, @@ -565,7 +565,7 @@ }, "x-appwrite": { "method": "updateMFA", - "weight": 44, + "weight": 45, "cookies": false, "type": "", "deprecated": false, @@ -638,7 +638,7 @@ }, "x-appwrite": { "method": "createMfaAuthenticator", - "weight": 46, + "weight": 47, "cookies": false, "type": "", "deprecated": false, @@ -704,7 +704,7 @@ }, "x-appwrite": { "method": "updateMfaAuthenticator", - "weight": 47, + "weight": 48, "cookies": false, "type": "", "deprecated": false, @@ -783,7 +783,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 51, + "weight": 52, "cookies": false, "type": "", "deprecated": false, @@ -851,7 +851,7 @@ }, "x-appwrite": { "method": "createMfaChallenge", - "weight": 52, + "weight": 53, "cookies": false, "type": "", "deprecated": false, @@ -927,7 +927,7 @@ }, "x-appwrite": { "method": "updateMfaChallenge", - "weight": 53, + "weight": 54, "cookies": false, "type": "", "deprecated": false, @@ -1007,7 +1007,7 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 45, + "weight": 46, "cookies": false, "type": "", "deprecated": false, @@ -1060,7 +1060,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 50, + "weight": 51, "cookies": false, "type": "", "deprecated": false, @@ -1111,7 +1111,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 48, + "weight": 49, "cookies": false, "type": "", "deprecated": false, @@ -1162,7 +1162,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 49, + "weight": 50, "cookies": false, "type": "", "deprecated": false, @@ -1215,7 +1215,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 32, + "weight": 33, "cookies": false, "type": "", "deprecated": false, @@ -1288,7 +1288,7 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 33, + "weight": 34, "cookies": false, "type": "", "deprecated": false, @@ -1367,7 +1367,7 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 35, + "weight": 36, "cookies": false, "type": "", "deprecated": false, @@ -1447,7 +1447,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 30, + "weight": 31, "cookies": false, "type": "", "deprecated": false, @@ -1498,7 +1498,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 36, + "weight": 37, "cookies": false, "type": "", "deprecated": false, @@ -1571,7 +1571,7 @@ }, "x-appwrite": { "method": "createRecovery", - "weight": 38, + "weight": 39, "cookies": false, "type": "", "deprecated": false, @@ -1652,7 +1652,7 @@ }, "x-appwrite": { "method": "updateRecovery", - "weight": 39, + "weight": 40, "cookies": false, "type": "", "deprecated": false, @@ -1739,7 +1739,7 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 11, + "weight": 12, "cookies": false, "type": "", "deprecated": false, @@ -1785,7 +1785,7 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 12, + "weight": 13, "cookies": false, "type": "", "deprecated": false, @@ -1838,7 +1838,7 @@ }, "x-appwrite": { "method": "createAnonymousSession", - "weight": 17, + "weight": 18, "cookies": false, "type": "", "deprecated": false, @@ -1888,7 +1888,7 @@ }, "x-appwrite": { "method": "createEmailPasswordSession", - "weight": 16, + "weight": 17, "cookies": false, "type": "", "deprecated": false, @@ -1965,7 +1965,7 @@ }, "x-appwrite": { "method": "updateMagicURLSession", - "weight": 26, + "weight": 27, "cookies": false, "type": "", "deprecated": true, @@ -2042,7 +2042,7 @@ }, "x-appwrite": { "method": "updatePhoneSession", - "weight": 27, + "weight": 28, "cookies": false, "type": "", "deprecated": true, @@ -2119,7 +2119,7 @@ }, "x-appwrite": { "method": "createSession", - "weight": 18, + "weight": 19, "cookies": false, "type": "", "deprecated": false, @@ -2196,7 +2196,7 @@ }, "x-appwrite": { "method": "getSession", - "weight": 13, + "weight": 14, "cookies": false, "type": "", "deprecated": false, @@ -2257,7 +2257,7 @@ }, "x-appwrite": { "method": "updateSession", - "weight": 15, + "weight": 16, "cookies": false, "type": "", "deprecated": false, @@ -2313,7 +2313,7 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 14, + "weight": 15, "cookies": false, "type": "", "deprecated": false, @@ -2376,7 +2376,7 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 37, + "weight": 38, "cookies": false, "type": "", "deprecated": false, @@ -2429,7 +2429,7 @@ }, "x-appwrite": { "method": "createEmailToken", - "weight": 25, + "weight": 26, "cookies": false, "type": "", "deprecated": false, @@ -2512,7 +2512,7 @@ }, "x-appwrite": { "method": "createMagicURLToken", - "weight": 24, + "weight": 25, "cookies": false, "type": "", "deprecated": false, @@ -2601,7 +2601,7 @@ }, "x-appwrite": { "method": "createOAuth2Token", - "weight": 23, + "weight": 24, "cookies": false, "type": "webAuth", "deprecated": false, @@ -2736,7 +2736,7 @@ }, "x-appwrite": { "method": "createPhoneToken", - "weight": 28, + "weight": 29, "cookies": false, "type": "", "deprecated": false, @@ -2816,7 +2816,7 @@ }, "x-appwrite": { "method": "createVerification", - "weight": 40, + "weight": 41, "cookies": false, "type": "", "deprecated": false, @@ -2887,7 +2887,7 @@ }, "x-appwrite": { "method": "updateVerification", - "weight": 41, + "weight": 42, "cookies": false, "type": "", "deprecated": false, @@ -2967,7 +2967,7 @@ }, "x-appwrite": { "method": "createPhoneVerification", - "weight": 42, + "weight": 43, "cookies": false, "type": "", "deprecated": false, @@ -3021,7 +3021,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 43, + "weight": 44, "cookies": false, "type": "", "deprecated": false, @@ -3101,7 +3101,7 @@ }, "x-appwrite": { "method": "getBrowser", - "weight": 60, + "weight": 61, "cookies": false, "type": "location", "deprecated": false, @@ -3229,7 +3229,7 @@ }, "x-appwrite": { "method": "getCreditCard", - "weight": 59, + "weight": 60, "cookies": false, "type": "location", "deprecated": false, @@ -3363,7 +3363,7 @@ }, "x-appwrite": { "method": "getFavicon", - "weight": 63, + "weight": 64, "cookies": false, "type": "location", "deprecated": false, @@ -3429,7 +3429,7 @@ }, "x-appwrite": { "method": "getFlag", - "weight": 61, + "weight": 62, "cookies": false, "type": "location", "deprecated": false, @@ -3919,7 +3919,7 @@ }, "x-appwrite": { "method": "getImage", - "weight": 62, + "weight": 63, "cookies": false, "type": "location", "deprecated": false, @@ -4005,7 +4005,7 @@ }, "x-appwrite": { "method": "getInitials", - "weight": 65, + "weight": 66, "cookies": false, "type": "location", "deprecated": false, @@ -4099,7 +4099,7 @@ }, "x-appwrite": { "method": "getQR", - "weight": 64, + "weight": 65, "cookies": false, "type": "location", "deprecated": false, @@ -4193,7 +4193,7 @@ }, "x-appwrite": { "method": "list", - "weight": 70, + "weight": 71, "cookies": false, "type": "", "deprecated": false, @@ -4265,7 +4265,7 @@ }, "x-appwrite": { "method": "create", - "weight": 69, + "weight": 70, "cookies": false, "type": "", "deprecated": false, @@ -4349,7 +4349,7 @@ }, "x-appwrite": { "method": "get", - "weight": 71, + "weight": 72, "cookies": false, "type": "", "deprecated": false, @@ -4408,7 +4408,7 @@ }, "x-appwrite": { "method": "update", - "weight": 73, + "weight": 74, "cookies": false, "type": "", "deprecated": false, @@ -4486,7 +4486,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 74, + "weight": 75, "cookies": false, "type": "", "deprecated": false, @@ -4547,7 +4547,7 @@ }, "x-appwrite": { "method": "listCollections", - "weight": 76, + "weight": 77, "cookies": false, "type": "", "deprecated": false, @@ -4627,7 +4627,7 @@ }, "x-appwrite": { "method": "createCollection", - "weight": 75, + "weight": 76, "cookies": false, "type": "", "deprecated": false, @@ -4734,7 +4734,7 @@ }, "x-appwrite": { "method": "getCollection", - "weight": 77, + "weight": 78, "cookies": false, "type": "", "deprecated": false, @@ -4801,7 +4801,7 @@ }, "x-appwrite": { "method": "updateCollection", - "weight": 79, + "weight": 80, "cookies": false, "type": "", "deprecated": false, @@ -4902,7 +4902,7 @@ }, "x-appwrite": { "method": "deleteCollection", - "weight": 80, + "weight": 81, "cookies": false, "type": "", "deprecated": false, @@ -4971,7 +4971,7 @@ }, "x-appwrite": { "method": "listAttributes", - "weight": 91, + "weight": 92, "cookies": false, "type": "", "deprecated": false, @@ -5052,7 +5052,7 @@ }, "x-appwrite": { "method": "createBooleanAttribute", - "weight": 88, + "weight": 89, "cookies": false, "type": "", "deprecated": false, @@ -5158,7 +5158,7 @@ }, "x-appwrite": { "method": "updateBooleanAttribute", - "weight": 100, + "weight": 101, "cookies": false, "type": "", "deprecated": false, @@ -5266,7 +5266,7 @@ }, "x-appwrite": { "method": "createDatetimeAttribute", - "weight": 89, + "weight": 90, "cookies": false, "type": "", "deprecated": false, @@ -5372,7 +5372,7 @@ }, "x-appwrite": { "method": "updateDatetimeAttribute", - "weight": 101, + "weight": 102, "cookies": false, "type": "", "deprecated": false, @@ -5480,7 +5480,7 @@ }, "x-appwrite": { "method": "createEmailAttribute", - "weight": 82, + "weight": 83, "cookies": false, "type": "", "deprecated": false, @@ -5586,7 +5586,7 @@ }, "x-appwrite": { "method": "updateEmailAttribute", - "weight": 94, + "weight": 95, "cookies": false, "type": "", "deprecated": false, @@ -5694,7 +5694,7 @@ }, "x-appwrite": { "method": "createEnumAttribute", - "weight": 83, + "weight": 84, "cookies": false, "type": "", "deprecated": false, @@ -5810,7 +5810,7 @@ }, "x-appwrite": { "method": "updateEnumAttribute", - "weight": 95, + "weight": 96, "cookies": false, "type": "", "deprecated": false, @@ -5928,7 +5928,7 @@ }, "x-appwrite": { "method": "createFloatAttribute", - "weight": 87, + "weight": 88, "cookies": false, "type": "", "deprecated": false, @@ -6046,7 +6046,7 @@ }, "x-appwrite": { "method": "updateFloatAttribute", - "weight": 99, + "weight": 100, "cookies": false, "type": "", "deprecated": false, @@ -6168,7 +6168,7 @@ }, "x-appwrite": { "method": "createIntegerAttribute", - "weight": 86, + "weight": 87, "cookies": false, "type": "", "deprecated": false, @@ -6286,7 +6286,7 @@ }, "x-appwrite": { "method": "updateIntegerAttribute", - "weight": 98, + "weight": 99, "cookies": false, "type": "", "deprecated": false, @@ -6408,7 +6408,7 @@ }, "x-appwrite": { "method": "createIpAttribute", - "weight": 84, + "weight": 85, "cookies": false, "type": "", "deprecated": false, @@ -6514,7 +6514,7 @@ }, "x-appwrite": { "method": "updateIpAttribute", - "weight": 96, + "weight": 97, "cookies": false, "type": "", "deprecated": false, @@ -6622,7 +6622,7 @@ }, "x-appwrite": { "method": "createRelationshipAttribute", - "weight": 90, + "weight": 91, "cookies": false, "type": "", "deprecated": false, @@ -6755,7 +6755,7 @@ }, "x-appwrite": { "method": "createStringAttribute", - "weight": 81, + "weight": 82, "cookies": false, "type": "", "deprecated": false, @@ -6874,7 +6874,7 @@ }, "x-appwrite": { "method": "updateStringAttribute", - "weight": 93, + "weight": 94, "cookies": false, "type": "", "deprecated": false, @@ -6988,7 +6988,7 @@ }, "x-appwrite": { "method": "createUrlAttribute", - "weight": 85, + "weight": 86, "cookies": false, "type": "", "deprecated": false, @@ -7094,7 +7094,7 @@ }, "x-appwrite": { "method": "updateUrlAttribute", - "weight": 97, + "weight": 98, "cookies": false, "type": "", "deprecated": false, @@ -7233,7 +7233,7 @@ }, "x-appwrite": { "method": "getAttribute", - "weight": 92, + "weight": 93, "cookies": false, "type": "", "deprecated": false, @@ -7302,7 +7302,7 @@ }, "x-appwrite": { "method": "deleteAttribute", - "weight": 103, + "weight": 104, "cookies": false, "type": "", "deprecated": false, @@ -7378,7 +7378,7 @@ }, "x-appwrite": { "method": "updateRelationshipAttribute", - "weight": 102, + "weight": 103, "cookies": false, "type": "", "deprecated": false, @@ -7482,7 +7482,7 @@ }, "x-appwrite": { "method": "listDocuments", - "weight": 109, + "weight": 110, "cookies": false, "type": "", "deprecated": false, @@ -7565,7 +7565,7 @@ }, "x-appwrite": { "method": "createDocument", - "weight": 108, + "weight": 109, "cookies": false, "type": "", "deprecated": false, @@ -7672,7 +7672,7 @@ }, "x-appwrite": { "method": "getDocument", - "weight": 110, + "weight": 111, "cookies": false, "type": "", "deprecated": false, @@ -7763,7 +7763,7 @@ }, "x-appwrite": { "method": "updateDocument", - "weight": 112, + "weight": 113, "cookies": false, "type": "", "deprecated": false, @@ -7861,7 +7861,7 @@ }, "x-appwrite": { "method": "deleteDocument", - "weight": 113, + "weight": 114, "cookies": false, "type": "", "deprecated": false, @@ -7942,7 +7942,7 @@ }, "x-appwrite": { "method": "listIndexes", - "weight": 105, + "weight": 106, "cookies": false, "type": "", "deprecated": false, @@ -8021,7 +8021,7 @@ }, "x-appwrite": { "method": "createIndex", - "weight": 104, + "weight": 105, "cookies": false, "type": "", "deprecated": false, @@ -8141,7 +8141,7 @@ }, "x-appwrite": { "method": "getIndex", - "weight": 106, + "weight": 107, "cookies": false, "type": "", "deprecated": false, @@ -8210,7 +8210,7 @@ }, "x-appwrite": { "method": "deleteIndex", - "weight": 107, + "weight": 108, "cookies": false, "type": "", "deprecated": false, @@ -8286,7 +8286,7 @@ }, "x-appwrite": { "method": "list", - "weight": 388, + "weight": 367, "cookies": false, "type": "", "deprecated": false, @@ -8358,7 +8358,7 @@ }, "x-appwrite": { "method": "create", - "weight": 386, + "weight": 364, "cookies": false, "type": "", "deprecated": false, @@ -8468,8 +8468,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -8608,7 +8607,7 @@ }, "x-appwrite": { "method": "listRuntimes", - "weight": 389, + "weight": 369, "cookies": false, "type": "", "deprecated": false, @@ -8637,7 +8636,7 @@ }, "\/functions\/specifications": { "get": { - "summary": "List available function runtime specifications", + "summary": "List specifications", "operationId": "functionsListSpecifications", "consumes": [ "application\/json" @@ -8648,7 +8647,7 @@ "tags": [ "functions" ], - "description": "List allowed function specifications for this instance.\n", + "description": "", "responses": { "200": { "description": "Specifications List", @@ -8659,12 +8658,12 @@ }, "x-appwrite": { "method": "listSpecifications", - "weight": 288, + "weight": 370, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-specifications.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-specifications.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed function specifications for this instance.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8700,7 +8699,7 @@ "tags": [ "functions" ], - "description": "Get a function by its unique ID.", + "description": "", "responses": { "200": { "description": "Function", @@ -8711,12 +8710,12 @@ }, "x-appwrite": { "method": "get", - "weight": 289, + "weight": 365, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -8770,7 +8769,7 @@ }, "x-appwrite": { "method": "update", - "weight": 387, + "weight": 366, "cookies": false, "type": "", "deprecated": false, @@ -8882,8 +8881,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -9006,7 +9004,7 @@ "tags": [ "functions" ], - "description": "Delete a function by its unique ID.", + "description": "", "responses": { "204": { "description": "No content" @@ -9014,12 +9012,12 @@ }, "x-appwrite": { "method": "delete", - "weight": 294, + "weight": 368, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9051,6 +9049,85 @@ ] } }, + "\/functions\/{functionId}\/deployment": { + "patch": { + "summary": "Update function's deployment", + "operationId": "functionsUpdateFunctionDeployment", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Function", + "schema": { + "$ref": "#\/definitions\/function" + } + } + }, + "x-appwrite": { + "method": "updateFunctionDeployment", + "weight": 373, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-function-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.", + "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": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + ] + } + }, "\/functions\/{functionId}\/deployments": { "get": { "summary": "List deployments", @@ -9064,7 +9141,7 @@ "tags": [ "functions" ], - "description": "Get a list of all the function's code deployments. You can use the query params to filter your results.", + "description": "", "responses": { "200": { "description": "Deployments List", @@ -9075,12 +9152,12 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 295, + "weight": 374, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-deployments.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the function's code deployments. You can use the query params to filter your results.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9111,7 +9188,7 @@ }, { "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", + "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: buildSize, sourceSize, buildDuration, status, activate, type", "required": false, "type": "array", "collectionFormat": "multi", @@ -9155,7 +9232,7 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 390, + "weight": 371, "cookies": false, "type": "upload", "deprecated": false, @@ -9223,6 +9300,91 @@ ] } }, + "\/functions\/{functionId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "functionsCreateDuplicateDeployment", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "202": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } + } + }, + "x-appwrite": { + "method": "createDuplicateDeployment", + "weight": 379, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/create-duplicate-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate 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.", + "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": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + }, + "buildId": { + "type": "string", + "description": "Build unique ID.", + "default": "", + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + ] + } + }, "\/functions\/{functionId}\/deployments\/template": { "post": { "summary": "Create template deployment", @@ -9247,7 +9409,7 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 391, + "weight": 376, "cookies": false, "type": "", "deprecated": false, @@ -9353,7 +9515,7 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 392, + "weight": 377, "cookies": false, "type": "", "deprecated": false, @@ -9439,7 +9601,7 @@ "tags": [ "functions" ], - "description": "Get a code deployment by its unique ID.", + "description": "", "responses": { "200": { "description": "Deployment", @@ -9450,12 +9612,12 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 296, + "weight": 372, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9504,7 +9666,7 @@ "tags": [ "functions" ], - "description": "Delete a code deployment by its unique ID.", + "description": "", "responses": { "204": { "description": "No content" @@ -9512,12 +9674,12 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 297, + "weight": 375, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a code deployment by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9557,87 +9719,6 @@ ] } }, - "\/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": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "buildId": { - "type": "string", - "description": "Build unique ID.", - "default": "", - "x-example": "" - } - } - } - } - ] - } - }, "\/functions\/{functionId}\/deployments\/{deploymentId}\/download": { "get": { "summary": "Download deployment", @@ -9651,7 +9732,7 @@ "tags": [ "functions" ], - "description": "Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.", + "description": "", "responses": { "200": { "description": "File", @@ -9662,12 +9743,12 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 292, + "weight": 378, "cookies": false, "type": "location", "deprecated": false, "demo": "functions\/get-deployment-download.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment-download.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9689,6 +9770,90 @@ "JWT": [] } ], + "parameters": [ + { + "name": "functionId", + "description": "Function ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": null, + "x-enum-keys": [], + "default": "source", + "in": "query" + } + ] + } + }, + "\/functions\/{functionId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "functionsUpdateDeploymentStatus", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } + } + }, + "x-appwrite": { + "method": "updateDeploymentStatus", + "weight": 380, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-deployment-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and 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", @@ -9722,7 +9887,7 @@ "tags": [ "functions" ], - "description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.", + "description": "", "responses": { "200": { "description": "Executions List", @@ -9733,12 +9898,12 @@ }, "x-appwrite": { "method": "listExecutions", - "weight": 301, + "weight": 383, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-executions.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the current user function execution logs. You can use the query params to filter your results.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9806,7 +9971,7 @@ "tags": [ "functions" ], - "description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", + "description": "", "responses": { "201": { "description": "Execution", @@ -9817,12 +9982,12 @@ }, "x-appwrite": { "method": "createExecution", - "weight": 300, + "weight": 381, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/create-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterTrigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9926,7 +10091,7 @@ "tags": [ "functions" ], - "description": "Get a function execution log by its unique ID.", + "description": "", "responses": { "200": { "description": "Execution", @@ -9937,12 +10102,12 @@ }, "x-appwrite": { "method": "getExecution", - "weight": 302, + "weight": 382, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/get-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function execution log by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -9995,7 +10160,7 @@ "tags": [ "functions" ], - "description": "Delete a function execution by its unique ID.\n", + "description": "", "responses": { "204": { "description": "No content" @@ -10003,12 +10168,12 @@ }, "x-appwrite": { "method": "deleteExecution", - "weight": 303, + "weight": 384, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/delete-execution.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function execution by its unique ID.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10061,7 +10226,7 @@ "tags": [ "functions" ], - "description": "Get a list of all variables of a specific function.", + "description": "", "responses": { "200": { "description": "Variables List", @@ -10072,12 +10237,12 @@ }, "x-appwrite": { "method": "listVariables", - "weight": 305, + "weight": 389, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/list-variables.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all variables of a specific function.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10120,7 +10285,7 @@ "tags": [ "functions" ], - "description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.", + "description": "", "responses": { "201": { "description": "Variable", @@ -10131,12 +10296,12 @@ }, "x-appwrite": { "method": "createVariable", - "weight": 304, + "weight": 387, "cookies": false, "type": "", "deprecated": false, "demo": "functions\/create-variable.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new function environment variable. These variables can be accessed in the function at runtime as environment variables.", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10199,6 +10364,234 @@ ] } }, + "\/functions\/{functionId}\/variables\/{variableId}": { + "get": { + "summary": "Get variable", + "operationId": "functionsGetVariable", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Variable", + "schema": { + "$ref": "#\/definitions\/variable" + } + } + }, + "x-appwrite": { + "method": "getVariable", + "weight": 388, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/get-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a variable by its unique ID.", + "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": "", + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update variable", + "operationId": "functionsUpdateVariable", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "200": { + "description": "Variable", + "schema": { + "$ref": "#\/definitions\/variable" + } + } + }, + "x-appwrite": { + "method": "updateVariable", + "weight": 390, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/update-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate variable by its unique ID.", + "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": "", + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "default": null, + "x-example": "" + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.", + "default": null, + "x-example": false + } + }, + "required": [ + "key" + ] + } + } + ] + }, + "delete": { + "summary": "Delete variable", + "operationId": "functionsDeleteVariable", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "functions" + ], + "description": "", + "responses": { + "204": { + "description": "No content" + } + }, + "x-appwrite": { + "method": "deleteVariable", + "weight": 391, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "functions\/delete-variable.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a variable by its unique ID.", + "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": "", + "in": "path" + }, + { + "name": "variableId", + "description": "Variable unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, "\/graphql": { "post": { "summary": "GraphQL endpoint", @@ -10223,7 +10616,7 @@ }, "x-appwrite": { "method": "query", - "weight": 325, + "weight": 303, "cookies": false, "type": "graphql", "deprecated": false, @@ -10298,7 +10691,7 @@ }, "x-appwrite": { "method": "mutation", - "weight": 324, + "weight": 302, "cookies": false, "type": "graphql", "deprecated": false, @@ -10373,7 +10766,7 @@ }, "x-appwrite": { "method": "get", - "weight": 125, + "weight": 126, "cookies": false, "type": "", "deprecated": false, @@ -10424,7 +10817,7 @@ }, "x-appwrite": { "method": "getAntivirus", - "weight": 147, + "weight": 148, "cookies": false, "type": "", "deprecated": false, @@ -10475,7 +10868,7 @@ }, "x-appwrite": { "method": "getCache", - "weight": 128, + "weight": 129, "cookies": false, "type": "", "deprecated": false, @@ -10526,7 +10919,7 @@ }, "x-appwrite": { "method": "getCertificate", - "weight": 133, + "weight": 134, "cookies": false, "type": "", "deprecated": false, @@ -10586,7 +10979,7 @@ }, "x-appwrite": { "method": "getDB", - "weight": 127, + "weight": 128, "cookies": false, "type": "", "deprecated": false, @@ -10637,7 +11030,7 @@ }, "x-appwrite": { "method": "getPubSub", - "weight": 129, + "weight": 130, "cookies": false, "type": "", "deprecated": false, @@ -10688,7 +11081,7 @@ }, "x-appwrite": { "method": "getQueueBuilds", - "weight": 135, + "weight": 136, "cookies": false, "type": "", "deprecated": false, @@ -10750,7 +11143,7 @@ }, "x-appwrite": { "method": "getQueueCertificates", - "weight": 134, + "weight": 135, "cookies": false, "type": "", "deprecated": false, @@ -10812,7 +11205,7 @@ }, "x-appwrite": { "method": "getQueueDatabases", - "weight": 136, + "weight": 137, "cookies": false, "type": "", "deprecated": false, @@ -10883,7 +11276,7 @@ }, "x-appwrite": { "method": "getQueueDeletes", - "weight": 137, + "weight": 138, "cookies": false, "type": "", "deprecated": false, @@ -10945,7 +11338,7 @@ }, "x-appwrite": { "method": "getFailedJobs", - "weight": 148, + "weight": 149, "cookies": false, "type": "", "deprecated": false, @@ -11032,7 +11425,7 @@ }, "x-appwrite": { "method": "getQueueFunctions", - "weight": 141, + "weight": 142, "cookies": false, "type": "", "deprecated": false, @@ -11094,7 +11487,7 @@ }, "x-appwrite": { "method": "getQueueLogs", - "weight": 132, + "weight": 133, "cookies": false, "type": "", "deprecated": false, @@ -11156,7 +11549,7 @@ }, "x-appwrite": { "method": "getQueueMails", - "weight": 138, + "weight": 139, "cookies": false, "type": "", "deprecated": false, @@ -11218,7 +11611,7 @@ }, "x-appwrite": { "method": "getQueueMessaging", - "weight": 139, + "weight": 140, "cookies": false, "type": "", "deprecated": false, @@ -11280,7 +11673,7 @@ }, "x-appwrite": { "method": "getQueueMigrations", - "weight": 140, + "weight": 141, "cookies": false, "type": "", "deprecated": false, @@ -11342,7 +11735,7 @@ }, "x-appwrite": { "method": "getQueueStatsResources", - "weight": 142, + "weight": 143, "cookies": false, "type": "", "deprecated": false, @@ -11404,7 +11797,7 @@ }, "x-appwrite": { "method": "getQueueUsage", - "weight": 143, + "weight": 144, "cookies": false, "type": "", "deprecated": false, @@ -11466,7 +11859,7 @@ }, "x-appwrite": { "method": "getQueueStatsUsageDump", - "weight": 144, + "weight": 145, "cookies": false, "type": "", "deprecated": false, @@ -11528,7 +11921,7 @@ }, "x-appwrite": { "method": "getQueueWebhooks", - "weight": 131, + "weight": 132, "cookies": false, "type": "", "deprecated": false, @@ -11590,7 +11983,7 @@ }, "x-appwrite": { "method": "getStorage", - "weight": 146, + "weight": 147, "cookies": false, "type": "", "deprecated": false, @@ -11641,7 +12034,7 @@ }, "x-appwrite": { "method": "getStorageLocal", - "weight": 145, + "weight": 146, "cookies": false, "type": "", "deprecated": false, @@ -11692,7 +12085,7 @@ }, "x-appwrite": { "method": "getTime", - "weight": 130, + "weight": 131, "cookies": false, "type": "", "deprecated": false, @@ -11743,7 +12136,7 @@ }, "x-appwrite": { "method": "get", - "weight": 117, + "weight": 118, "cookies": false, "type": "", "deprecated": false, @@ -11798,7 +12191,7 @@ }, "x-appwrite": { "method": "listCodes", - "weight": 118, + "weight": 119, "cookies": false, "type": "", "deprecated": false, @@ -11853,7 +12246,7 @@ }, "x-appwrite": { "method": "listContinents", - "weight": 122, + "weight": 123, "cookies": false, "type": "", "deprecated": false, @@ -11908,7 +12301,7 @@ }, "x-appwrite": { "method": "listCountries", - "weight": 119, + "weight": 120, "cookies": false, "type": "", "deprecated": false, @@ -11963,7 +12356,7 @@ }, "x-appwrite": { "method": "listCountriesEU", - "weight": 120, + "weight": 121, "cookies": false, "type": "", "deprecated": false, @@ -12018,7 +12411,7 @@ }, "x-appwrite": { "method": "listCountriesPhones", - "weight": 121, + "weight": 122, "cookies": false, "type": "", "deprecated": false, @@ -12073,7 +12466,7 @@ }, "x-appwrite": { "method": "listCurrencies", - "weight": 123, + "weight": 124, "cookies": false, "type": "", "deprecated": false, @@ -12128,7 +12521,7 @@ }, "x-appwrite": { "method": "listLanguages", - "weight": 124, + "weight": 125, "cookies": false, "type": "", "deprecated": false, @@ -12183,7 +12576,7 @@ }, "x-appwrite": { "method": "listMessages", - "weight": 378, + "weight": 356, "cookies": false, "type": "", "deprecated": false, @@ -12258,7 +12651,7 @@ }, "x-appwrite": { "method": "createEmail", - "weight": 375, + "weight": 353, "cookies": false, "type": "", "deprecated": false, @@ -12416,7 +12809,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 382, + "weight": 360, "cookies": false, "type": "", "deprecated": false, @@ -12571,7 +12964,7 @@ }, "x-appwrite": { "method": "createPush", - "weight": 377, + "weight": 355, "cookies": false, "type": "", "deprecated": false, @@ -12766,7 +13159,7 @@ }, "x-appwrite": { "method": "updatePush", - "weight": 384, + "weight": 362, "cookies": false, "type": "", "deprecated": false, @@ -12960,7 +13353,7 @@ }, "x-appwrite": { "method": "createSms", - "weight": 376, + "weight": 354, "cookies": false, "type": "", "deprecated": false, @@ -13078,7 +13471,7 @@ }, "x-appwrite": { "method": "updateSms", - "weight": 383, + "weight": 361, "cookies": false, "type": "", "deprecated": false, @@ -13194,7 +13587,7 @@ }, "x-appwrite": { "method": "getMessage", - "weight": 381, + "weight": 359, "cookies": false, "type": "", "deprecated": false, @@ -13249,7 +13642,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 385, + "weight": 363, "cookies": false, "type": "", "deprecated": false, @@ -13311,7 +13704,7 @@ }, "x-appwrite": { "method": "listMessageLogs", - "weight": 379, + "weight": 357, "cookies": false, "type": "", "deprecated": false, @@ -13385,7 +13778,7 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 380, + "weight": 358, "cookies": false, "type": "", "deprecated": false, @@ -13459,7 +13852,7 @@ }, "x-appwrite": { "method": "listProviders", - "weight": 350, + "weight": 328, "cookies": false, "type": "", "deprecated": false, @@ -13534,7 +13927,7 @@ }, "x-appwrite": { "method": "createApnsProvider", - "weight": 349, + "weight": 327, "cookies": false, "type": "", "deprecated": false, @@ -13649,7 +14042,7 @@ }, "x-appwrite": { "method": "updateApnsProvider", - "weight": 362, + "weight": 340, "cookies": false, "type": "", "deprecated": false, @@ -13762,7 +14155,7 @@ }, "x-appwrite": { "method": "createFcmProvider", - "weight": 348, + "weight": 326, "cookies": false, "type": "", "deprecated": false, @@ -13853,7 +14246,7 @@ }, "x-appwrite": { "method": "updateFcmProvider", - "weight": 361, + "weight": 339, "cookies": false, "type": "", "deprecated": false, @@ -13942,7 +14335,7 @@ }, "x-appwrite": { "method": "createMailgunProvider", - "weight": 340, + "weight": 318, "cookies": false, "type": "", "deprecated": false, @@ -14069,7 +14462,7 @@ }, "x-appwrite": { "method": "updateMailgunProvider", - "weight": 353, + "weight": 331, "cookies": false, "type": "", "deprecated": false, @@ -14194,7 +14587,7 @@ }, "x-appwrite": { "method": "createMsg91Provider", - "weight": 343, + "weight": 321, "cookies": false, "type": "", "deprecated": false, @@ -14297,7 +14690,7 @@ }, "x-appwrite": { "method": "updateMsg91Provider", - "weight": 356, + "weight": 334, "cookies": false, "type": "", "deprecated": false, @@ -14398,7 +14791,7 @@ }, "x-appwrite": { "method": "createSendgridProvider", - "weight": 341, + "weight": 319, "cookies": false, "type": "", "deprecated": false, @@ -14513,7 +14906,7 @@ }, "x-appwrite": { "method": "updateSendgridProvider", - "weight": 354, + "weight": 332, "cookies": false, "type": "", "deprecated": false, @@ -14626,7 +15019,7 @@ }, "x-appwrite": { "method": "createSmtpProvider", - "weight": 342, + "weight": 320, "cookies": false, "type": "", "deprecated": false, @@ -14785,7 +15178,7 @@ }, "x-appwrite": { "method": "updateSmtpProvider", - "weight": 355, + "weight": 333, "cookies": false, "type": "", "deprecated": false, @@ -14941,7 +15334,7 @@ }, "x-appwrite": { "method": "createTelesignProvider", - "weight": 344, + "weight": 322, "cookies": false, "type": "", "deprecated": false, @@ -15044,7 +15437,7 @@ }, "x-appwrite": { "method": "updateTelesignProvider", - "weight": 357, + "weight": 335, "cookies": false, "type": "", "deprecated": false, @@ -15145,7 +15538,7 @@ }, "x-appwrite": { "method": "createTextmagicProvider", - "weight": 345, + "weight": 323, "cookies": false, "type": "", "deprecated": false, @@ -15248,7 +15641,7 @@ }, "x-appwrite": { "method": "updateTextmagicProvider", - "weight": 358, + "weight": 336, "cookies": false, "type": "", "deprecated": false, @@ -15349,7 +15742,7 @@ }, "x-appwrite": { "method": "createTwilioProvider", - "weight": 346, + "weight": 324, "cookies": false, "type": "", "deprecated": false, @@ -15452,7 +15845,7 @@ }, "x-appwrite": { "method": "updateTwilioProvider", - "weight": 359, + "weight": 337, "cookies": false, "type": "", "deprecated": false, @@ -15553,7 +15946,7 @@ }, "x-appwrite": { "method": "createVonageProvider", - "weight": 347, + "weight": 325, "cookies": false, "type": "", "deprecated": false, @@ -15656,7 +16049,7 @@ }, "x-appwrite": { "method": "updateVonageProvider", - "weight": 360, + "weight": 338, "cookies": false, "type": "", "deprecated": false, @@ -15757,7 +16150,7 @@ }, "x-appwrite": { "method": "getProvider", - "weight": 352, + "weight": 330, "cookies": false, "type": "", "deprecated": false, @@ -15812,7 +16205,7 @@ }, "x-appwrite": { "method": "deleteProvider", - "weight": 363, + "weight": 341, "cookies": false, "type": "", "deprecated": false, @@ -15874,7 +16267,7 @@ }, "x-appwrite": { "method": "listProviderLogs", - "weight": 351, + "weight": 329, "cookies": false, "type": "", "deprecated": false, @@ -15948,7 +16341,7 @@ }, "x-appwrite": { "method": "listSubscriberLogs", - "weight": 372, + "weight": 350, "cookies": false, "type": "", "deprecated": false, @@ -16022,7 +16415,7 @@ }, "x-appwrite": { "method": "listTopics", - "weight": 365, + "weight": 343, "cookies": false, "type": "", "deprecated": false, @@ -16095,7 +16488,7 @@ }, "x-appwrite": { "method": "createTopic", - "weight": 364, + "weight": 342, "cookies": false, "type": "", "deprecated": false, @@ -16185,7 +16578,7 @@ }, "x-appwrite": { "method": "getTopic", - "weight": 367, + "weight": 345, "cookies": false, "type": "", "deprecated": false, @@ -16245,7 +16638,7 @@ }, "x-appwrite": { "method": "updateTopic", - "weight": 368, + "weight": 346, "cookies": false, "type": "", "deprecated": false, @@ -16324,7 +16717,7 @@ }, "x-appwrite": { "method": "deleteTopic", - "weight": 369, + "weight": 347, "cookies": false, "type": "", "deprecated": false, @@ -16386,7 +16779,7 @@ }, "x-appwrite": { "method": "listTopicLogs", - "weight": 366, + "weight": 344, "cookies": false, "type": "", "deprecated": false, @@ -16460,7 +16853,7 @@ }, "x-appwrite": { "method": "listSubscribers", - "weight": 371, + "weight": 349, "cookies": false, "type": "", "deprecated": false, @@ -16541,7 +16934,7 @@ }, "x-appwrite": { "method": "createSubscriber", - "weight": 370, + "weight": 348, "cookies": false, "type": "", "deprecated": false, @@ -16632,7 +17025,7 @@ }, "x-appwrite": { "method": "getSubscriber", - "weight": 373, + "weight": 351, "cookies": false, "type": "", "deprecated": false, @@ -16695,7 +17088,7 @@ }, "x-appwrite": { "method": "deleteSubscriber", - "weight": 374, + "weight": 352, "cookies": false, "type": "", "deprecated": false, @@ -16769,7 +17162,7 @@ }, "x-appwrite": { "method": "list", - "weight": 395, + "weight": 396, "cookies": false, "type": "", "deprecated": false, @@ -16841,7 +17234,7 @@ }, "x-appwrite": { "method": "create", - "weight": 393, + "weight": 394, "cookies": false, "type": "", "deprecated": false, @@ -17000,8 +17393,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -17096,7 +17488,7 @@ }, "x-appwrite": { "method": "listFrameworks", - "weight": 398, + "weight": 399, "cookies": false, "type": "", "deprecated": false, @@ -17123,6 +17515,58 @@ ] } }, + "\/sites\/specifications": { + "get": { + "summary": "List specifications", + "operationId": "sitesListSpecifications", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Specifications List", + "schema": { + "$ref": "#\/definitions\/specificationList" + } + } + }, + "x-appwrite": { + "method": "listSpecifications", + "weight": 422, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/list-specifications.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed site specifications for this instance.", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.read", + "platforms": [ + "server", + "console" + ], + "packaging": false, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ] + } + }, "\/sites\/{siteId}": { "get": { "summary": "Get site", @@ -17147,7 +17591,7 @@ }, "x-appwrite": { "method": "get", - "weight": 394, + "weight": 395, "cookies": false, "type": "", "deprecated": false, @@ -17206,7 +17650,7 @@ }, "x-appwrite": { "method": "update", - "weight": 396, + "weight": 397, "cookies": false, "type": "", "deprecated": false, @@ -17367,8 +17811,7 @@ "bun-1.1", "go-1.23", "static-1", - "flutter-3.24", - "ssr-22" + "flutter-3.24" ], "x-enum-name": null, "x-enum-keys": [] @@ -17454,7 +17897,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 397, + "weight": 398, "cookies": false, "type": "", "deprecated": false, @@ -17491,6 +17934,85 @@ ] } }, + "\/sites\/{siteId}\/deployment": { + "patch": { + "summary": "Update site's deployment", + "operationId": "sitesUpdateSiteDeployment", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Site", + "schema": { + "$ref": "#\/definitions\/site" + } + } + }, + "x-appwrite": { + "method": "updateSiteDeployment", + "weight": 405, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/update-site-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", + "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": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + ] + } + }, "\/sites\/{siteId}\/deployments": { "get": { "summary": "List deployments", @@ -17515,7 +18037,7 @@ }, "x-appwrite": { "method": "listDeployments", - "weight": 403, + "weight": 404, "cookies": false, "type": "", "deprecated": false, @@ -17551,7 +18073,7 @@ }, { "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", + "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: buildSize, sourceSize, buildDuration, status, activate, type", "required": false, "type": "array", "collectionFormat": "multi", @@ -17595,7 +18117,7 @@ }, "x-appwrite": { "method": "createDeployment", - "weight": 399, + "weight": 400, "cookies": false, "type": "upload", "deprecated": false, @@ -17671,6 +18193,85 @@ ] } }, + "\/sites\/{siteId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "sitesCreateDuplicateDeployment", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "", + "responses": { + "202": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } + } + }, + "x-appwrite": { + "method": "createDuplicateDeployment", + "weight": 408, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/create-duplicate-deployment.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands 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.", + "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": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } + } + ] + } + }, "\/sites\/{siteId}\/deployments\/template": { "post": { "summary": "Create deployment", @@ -17695,7 +18296,7 @@ }, "x-appwrite": { "method": "createTemplateDeployment", - "weight": 400, + "weight": 401, "cookies": false, "type": "", "deprecated": false, @@ -17801,7 +18402,7 @@ }, "x-appwrite": { "method": "createVcsDeployment", - "weight": 401, + "weight": 402, "cookies": false, "type": "", "deprecated": false, @@ -17898,7 +18499,7 @@ }, "x-appwrite": { "method": "getDeployment", - "weight": 402, + "weight": 403, "cookies": false, "type": "", "deprecated": false, @@ -17942,73 +18543,6 @@ } ] }, - "patch": { - "summary": "Update deployment", - "operationId": "sitesUpdateDeployment", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "Function", - "schema": { - "$ref": "#\/definitions\/function" - } - } - }, - "x-appwrite": { - "method": "updateDeployment", - "weight": 404, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/update-deployment.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", - "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": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, "delete": { "summary": "Delete deployment", "operationId": "sitesDeleteDeployment", @@ -18027,7 +18561,7 @@ }, "x-appwrite": { "method": "deleteDeployment", - "weight": 405, + "weight": 406, "cookies": false, "type": "", "deprecated": false, @@ -18072,210 +18606,6 @@ ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/build": { - "post": { - "summary": "Rebuild deployment", - "operationId": "sitesCreateDeploymentBuild", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "", - "responses": { - "204": { - "description": "No content" - } - }, - "x-appwrite": { - "method": "createDeploymentBuild", - "weight": 408, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/create-deployment-build.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands 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.", - "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": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "patch": { - "summary": "Cancel deployment", - "operationId": "sitesUpdateDeploymentBuild", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "Build", - "schema": { - "$ref": "#\/definitions\/build" - } - } - }, - "x-appwrite": { - "method": "updateDeploymentBuild", - "weight": 409, - "cookies": false, - "type": "", - "deprecated": false, - "demo": "sites\/update-deployment-build.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and 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": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/build\/download": { - "get": { - "summary": "Download build", - "operationId": "sitesGetDeploymentBuildDownload", - "consumes": [ - "application\/json" - ], - "produces": [ - "*\/*" - ], - "tags": [ - "sites" - ], - "description": "", - "responses": { - "200": { - "description": "File", - "schema": { - "type": "file" - } - } - }, - "x-appwrite": { - "method": "getDeploymentBuildDownload", - "weight": 407, - "cookies": false, - "type": "location", - "deprecated": false, - "demo": "sites\/get-deployment-build-download.md", - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site build content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "server", - "server" - ], - "packaging": false, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { "get": { "summary": "Download deployment", @@ -18300,7 +18630,7 @@ }, "x-appwrite": { "method": "getDeploymentDownload", - "weight": 406, + "weight": 407, "cookies": false, "type": "location", "deprecated": false, @@ -18327,6 +18657,90 @@ "JWT": [] } ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [], + "default": "source", + "in": "query" + } + ] + } + }, + "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "sitesUpdateDeploymentStatus", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "sites" + ], + "description": "", + "responses": { + "200": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } + } + }, + "x-appwrite": { + "method": "updateDeploymentStatus", + "weight": 409, + "cookies": false, + "type": "", + "deprecated": false, + "demo": "sites\/update-deployment-status.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and 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", @@ -18965,7 +19379,7 @@ }, "x-appwrite": { "method": "listBuckets", - "weight": 203, + "weight": 204, "cookies": false, "type": "", "deprecated": false, @@ -19037,7 +19451,7 @@ }, "x-appwrite": { "method": "createBucket", - "weight": 202, + "weight": 203, "cookies": false, "type": "", "deprecated": false, @@ -19176,7 +19590,7 @@ }, "x-appwrite": { "method": "getBucket", - "weight": 204, + "weight": 205, "cookies": false, "type": "", "deprecated": false, @@ -19235,7 +19649,7 @@ }, "x-appwrite": { "method": "updateBucket", - "weight": 205, + "weight": 206, "cookies": false, "type": "", "deprecated": false, @@ -19368,7 +19782,7 @@ }, "x-appwrite": { "method": "deleteBucket", - "weight": 206, + "weight": 207, "cookies": false, "type": "", "deprecated": false, @@ -19429,7 +19843,7 @@ }, "x-appwrite": { "method": "listFiles", - "weight": 208, + "weight": 209, "cookies": false, "type": "", "deprecated": false, @@ -19513,7 +19927,7 @@ }, "x-appwrite": { "method": "createFile", - "weight": 207, + "weight": 208, "cookies": false, "type": "upload", "deprecated": false, @@ -19606,7 +20020,7 @@ }, "x-appwrite": { "method": "getFile", - "weight": 209, + "weight": 210, "cookies": false, "type": "", "deprecated": false, @@ -19677,7 +20091,7 @@ }, "x-appwrite": { "method": "updateFile", - "weight": 214, + "weight": 215, "cookies": false, "type": "", "deprecated": false, @@ -19767,7 +20181,7 @@ }, "x-appwrite": { "method": "deleteFile", - "weight": 215, + "weight": 216, "cookies": false, "type": "", "deprecated": false, @@ -19840,7 +20254,7 @@ }, "x-appwrite": { "method": "getFileDownload", - "weight": 211, + "weight": 212, "cookies": false, "type": "location", "deprecated": false, @@ -19913,7 +20327,7 @@ }, "x-appwrite": { "method": "getFilePreview", - "weight": 210, + "weight": 211, "cookies": false, "type": "location", "deprecated": false, @@ -20114,7 +20528,7 @@ }, "x-appwrite": { "method": "getFileView", - "weight": 212, + "weight": 213, "cookies": false, "type": "location", "deprecated": false, @@ -20187,7 +20601,7 @@ }, "x-appwrite": { "method": "list", - "weight": 219, + "weight": 220, "cookies": false, "type": "", "deprecated": false, @@ -20263,7 +20677,7 @@ }, "x-appwrite": { "method": "create", - "weight": 218, + "weight": 219, "cookies": false, "type": "", "deprecated": false, @@ -20356,7 +20770,7 @@ }, "x-appwrite": { "method": "get", - "weight": 220, + "weight": 221, "cookies": false, "type": "", "deprecated": false, @@ -20419,7 +20833,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 222, + "weight": 223, "cookies": false, "type": "", "deprecated": false, @@ -20495,7 +20909,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 224, + "weight": 225, "cookies": false, "type": "", "deprecated": false, @@ -20560,7 +20974,7 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 226, + "weight": 227, "cookies": false, "type": "", "deprecated": false, @@ -20644,7 +21058,7 @@ }, "x-appwrite": { "method": "createMembership", - "weight": 225, + "weight": 226, "cookies": false, "type": "", "deprecated": false, @@ -20760,7 +21174,7 @@ }, "x-appwrite": { "method": "getMembership", - "weight": 227, + "weight": 228, "cookies": false, "type": "", "deprecated": false, @@ -20831,7 +21245,7 @@ }, "x-appwrite": { "method": "updateMembership", - "weight": 228, + "weight": 229, "cookies": false, "type": "", "deprecated": false, @@ -20918,7 +21332,7 @@ }, "x-appwrite": { "method": "deleteMembership", - "weight": 230, + "weight": 231, "cookies": false, "type": "", "deprecated": false, @@ -20991,7 +21405,7 @@ }, "x-appwrite": { "method": "updateMembershipStatus", - "weight": 229, + "weight": 230, "cookies": false, "type": "", "deprecated": false, @@ -21087,7 +21501,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 221, + "weight": 222, "cookies": false, "type": "", "deprecated": false, @@ -21148,7 +21562,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 223, + "weight": 224, "cookies": false, "type": "", "deprecated": false, @@ -21229,7 +21643,7 @@ }, "x-appwrite": { "method": "list", - "weight": 241, + "weight": 242, "cookies": false, "type": "", "deprecated": false, @@ -21301,7 +21715,7 @@ }, "x-appwrite": { "method": "create", - "weight": 232, + "weight": 233, "cookies": false, "type": "", "deprecated": false, @@ -21396,7 +21810,7 @@ }, "x-appwrite": { "method": "createArgon2User", - "weight": 235, + "weight": 236, "cookies": false, "type": "", "deprecated": false, @@ -21487,7 +21901,7 @@ }, "x-appwrite": { "method": "createBcryptUser", - "weight": 233, + "weight": 234, "cookies": false, "type": "", "deprecated": false, @@ -21578,7 +21992,7 @@ }, "x-appwrite": { "method": "listIdentities", - "weight": 249, + "weight": 250, "cookies": false, "type": "", "deprecated": false, @@ -21647,7 +22061,7 @@ }, "x-appwrite": { "method": "deleteIdentity", - "weight": 272, + "weight": 273, "cookies": false, "type": "", "deprecated": false, @@ -21708,7 +22122,7 @@ }, "x-appwrite": { "method": "createMD5User", - "weight": 234, + "weight": 235, "cookies": false, "type": "", "deprecated": false, @@ -21799,7 +22213,7 @@ }, "x-appwrite": { "method": "createPHPassUser", - "weight": 237, + "weight": 238, "cookies": false, "type": "", "deprecated": false, @@ -21890,7 +22304,7 @@ }, "x-appwrite": { "method": "createScryptUser", - "weight": 238, + "weight": 239, "cookies": false, "type": "", "deprecated": false, @@ -22016,7 +22430,7 @@ }, "x-appwrite": { "method": "createScryptModifiedUser", - "weight": 239, + "weight": 240, "cookies": false, "type": "", "deprecated": false, @@ -22128,7 +22542,7 @@ }, "x-appwrite": { "method": "createSHAUser", - "weight": 236, + "weight": 237, "cookies": false, "type": "", "deprecated": false, @@ -22240,7 +22654,7 @@ }, "x-appwrite": { "method": "get", - "weight": 242, + "weight": 243, "cookies": false, "type": "", "deprecated": false, @@ -22294,7 +22708,7 @@ }, "x-appwrite": { "method": "delete", - "weight": 270, + "weight": 271, "cookies": false, "type": "", "deprecated": false, @@ -22355,7 +22769,7 @@ }, "x-appwrite": { "method": "updateEmail", - "weight": 255, + "weight": 256, "cookies": false, "type": "", "deprecated": false, @@ -22434,7 +22848,7 @@ }, "x-appwrite": { "method": "createJWT", - "weight": 273, + "weight": 274, "cookies": false, "type": "", "deprecated": false, @@ -22516,7 +22930,7 @@ }, "x-appwrite": { "method": "updateLabels", - "weight": 251, + "weight": 252, "cookies": false, "type": "", "deprecated": false, @@ -22598,7 +23012,7 @@ }, "x-appwrite": { "method": "listLogs", - "weight": 247, + "weight": 248, "cookies": false, "type": "", "deprecated": false, @@ -22671,7 +23085,7 @@ }, "x-appwrite": { "method": "listMemberships", - "weight": 246, + "weight": 247, "cookies": false, "type": "", "deprecated": false, @@ -22732,7 +23146,7 @@ }, "x-appwrite": { "method": "updateMfa", - "weight": 260, + "weight": 261, "cookies": false, "type": "", "deprecated": false, @@ -22806,7 +23220,7 @@ }, "x-appwrite": { "method": "deleteMfaAuthenticator", - "weight": 265, + "weight": 266, "cookies": false, "type": "", "deprecated": false, @@ -22880,7 +23294,7 @@ }, "x-appwrite": { "method": "listMfaFactors", - "weight": 261, + "weight": 262, "cookies": false, "type": "", "deprecated": false, @@ -22941,7 +23355,7 @@ }, "x-appwrite": { "method": "getMfaRecoveryCodes", - "weight": 262, + "weight": 263, "cookies": false, "type": "", "deprecated": false, @@ -23000,7 +23414,7 @@ }, "x-appwrite": { "method": "updateMfaRecoveryCodes", - "weight": 264, + "weight": 265, "cookies": false, "type": "", "deprecated": false, @@ -23059,7 +23473,7 @@ }, "x-appwrite": { "method": "createMfaRecoveryCodes", - "weight": 263, + "weight": 264, "cookies": false, "type": "", "deprecated": false, @@ -23120,7 +23534,7 @@ }, "x-appwrite": { "method": "updateName", - "weight": 253, + "weight": 254, "cookies": false, "type": "", "deprecated": false, @@ -23199,7 +23613,7 @@ }, "x-appwrite": { "method": "updatePassword", - "weight": 254, + "weight": 255, "cookies": false, "type": "", "deprecated": false, @@ -23278,7 +23692,7 @@ }, "x-appwrite": { "method": "updatePhone", - "weight": 256, + "weight": 257, "cookies": false, "type": "", "deprecated": false, @@ -23357,7 +23771,7 @@ }, "x-appwrite": { "method": "getPrefs", - "weight": 243, + "weight": 244, "cookies": false, "type": "", "deprecated": false, @@ -23416,7 +23830,7 @@ }, "x-appwrite": { "method": "updatePrefs", - "weight": 258, + "weight": 259, "cookies": false, "type": "", "deprecated": false, @@ -23495,7 +23909,7 @@ }, "x-appwrite": { "method": "listSessions", - "weight": 245, + "weight": 246, "cookies": false, "type": "", "deprecated": false, @@ -23554,7 +23968,7 @@ }, "x-appwrite": { "method": "createSession", - "weight": 266, + "weight": 267, "cookies": false, "type": "", "deprecated": false, @@ -23608,7 +24022,7 @@ }, "x-appwrite": { "method": "deleteSessions", - "weight": 269, + "weight": 270, "cookies": false, "type": "", "deprecated": false, @@ -23664,7 +24078,7 @@ }, "x-appwrite": { "method": "deleteSession", - "weight": 268, + "weight": 269, "cookies": false, "type": "", "deprecated": false, @@ -23733,7 +24147,7 @@ }, "x-appwrite": { "method": "updateStatus", - "weight": 250, + "weight": 251, "cookies": false, "type": "", "deprecated": false, @@ -23812,7 +24226,7 @@ }, "x-appwrite": { "method": "listTargets", - "weight": 248, + "weight": 249, "cookies": false, "type": "", "deprecated": false, @@ -23884,7 +24298,7 @@ }, "x-appwrite": { "method": "createTarget", - "weight": 240, + "weight": 241, "cookies": false, "type": "", "deprecated": false, @@ -23997,7 +24411,7 @@ }, "x-appwrite": { "method": "getTarget", - "weight": 244, + "weight": 245, "cookies": false, "type": "", "deprecated": false, @@ -24065,7 +24479,7 @@ }, "x-appwrite": { "method": "updateTarget", - "weight": 259, + "weight": 260, "cookies": false, "type": "", "deprecated": false, @@ -24155,7 +24569,7 @@ }, "x-appwrite": { "method": "deleteTarget", - "weight": 271, + "weight": 272, "cookies": false, "type": "", "deprecated": false, @@ -24225,7 +24639,7 @@ }, "x-appwrite": { "method": "createToken", - "weight": 267, + "weight": 268, "cookies": false, "type": "", "deprecated": false, @@ -24307,7 +24721,7 @@ }, "x-appwrite": { "method": "updateEmailVerification", - "weight": 257, + "weight": 258, "cookies": false, "type": "", "deprecated": false, @@ -24386,7 +24800,7 @@ }, "x-appwrite": { "method": "updatePhoneVerification", - "weight": 252, + "weight": 253, "cookies": false, "type": "", "deprecated": false, @@ -28018,7 +28432,7 @@ "description": "The entrypoint file to use to execute the deployment code.", "x-example": "index.js" }, - "size": { + "sourceSize": { "type": "integer", "description": "The code size in bytes.", "x-example": 128, @@ -28060,7 +28474,7 @@ "description": "The build logs.", "x-example": "Compiling source files..." }, - "buildTime": { + "buildDuration": { "type": "integer", "description": "The current build time in seconds.", "x-example": 128, @@ -28125,7 +28539,7 @@ "resourceId", "resourceType", "entrypoint", - "size", + "sourceSize", "buildSize", "buildId", "activate", @@ -28133,7 +28547,7 @@ "screenshotDark", "status", "buildLogs", - "buildTime", + "buildDuration", "providerRepositoryName", "providerRepositoryOwner", "providerRepositoryUrl", @@ -28279,70 +28693,6 @@ "duration" ] }, - "build": { - "description": "Build", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Build ID.", - "x-example": "5e5ea5c16897e" - }, - "deploymentId": { - "type": "string", - "description": "The deployment that created this build.", - "x-example": "5e5ea5c16897e" - }, - "status": { - "type": "string", - "description": "The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built", - "x-example": "ready" - }, - "stdout": { - "type": "string", - "description": "The stdout of the build.", - "x-example": "" - }, - "stderr": { - "type": "string", - "description": "The stderr of the build.", - "x-example": "" - }, - "startTime": { - "type": "string", - "description": "The deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "endTime": { - "type": "string", - "description": "The time the build was finished in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" - }, - "duration": { - "type": "integer", - "description": "The build duration in seconds.", - "x-example": 0, - "format": "int32" - }, - "size": { - "type": "integer", - "description": "The code size in bytes.", - "x-example": 128, - "format": "int32" - } - }, - "required": [ - "$id", - "deploymentId", - "status", - "stdout", - "stderr", - "startTime", - "endTime", - "duration", - "size" - ] - }, "variable": { "description": "Variable", "type": "object",