From 258e1bd411f19f0b255db688240a89c3d9aa43b7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 11 Jun 2026 04:18:53 +0000 Subject: [PATCH] chore: update API specs with OpenAPI 3 parity fixes --- .../examples/databases/delete-document.md | 3 - .../examples/tablesdb/delete-row.md | 3 - .../databases/create-line-attribute.md | 2 +- .../databases/create-point-attribute.md | 2 +- .../databases/create-polygon-attribute.md | 2 +- .../databases/update-line-attribute.md | 2 +- .../databases/update-point-attribute.md | 2 +- .../databases/update-polygon-attribute.md | 2 +- .../examples/tablesdb/create-line-column.md | 2 +- .../examples/tablesdb/create-point-column.md | 2 +- .../tablesdb/create-polygon-column.md | 2 +- .../examples/tablesdb/update-line-column.md | 2 +- .../examples/tablesdb/update-point-column.md | 2 +- .../tablesdb/update-polygon-column.md | 2 +- .../examples/backups/create-policy.md | 2 + .../examples/backups/get-policy.md | 1 + .../examples/backups/list-policies.md | 1 + .../examples/backups/update-policy.md | 2 + .../examples/databases/create.md | 2 + .../server-graphql/examples/databases/get.md | 1 + .../server-graphql/examples/databases/list.md | 1 + .../examples/databases/update.md | 2 + .../examples/tablesdb/create.md | 2 + .../server-graphql/examples/tablesdb/get.md | 1 + .../server-graphql/examples/tablesdb/list.md | 1 + .../examples/tablesdb/update.md | 2 + .../examples/databases/delete-document.md | 3 - .../examples/databases/delete-documents.md | 8 - .../examples/tablesdb/delete-row.md | 3 - .../examples/tablesdb/delete-rows.md | 8 - specs/1.9.x/open-api3-1.9.x-client.json | 1418 +++-- specs/1.9.x/open-api3-1.9.x-console.json | 4704 ++++++++++++---- specs/1.9.x/open-api3-1.9.x-server.json | 4821 ++++++++++++----- specs/1.9.x/swagger2-1.9.x-client.json | 192 +- specs/1.9.x/swagger2-1.9.x-console.json | 1363 +++-- specs/1.9.x/swagger2-1.9.x-server.json | 568 +- 36 files changed, 9280 insertions(+), 3856 deletions(-) diff --git a/examples/1.9.x/client-rest/examples/databases/delete-document.md b/examples/1.9.x/client-rest/examples/databases/delete-document.md index a4472d07..eeb3394e 100644 --- a/examples/1.9.x/client-rest/examples/databases/delete-document.md +++ b/examples/1.9.x/client-rest/examples/databases/delete-document.md @@ -5,7 +5,4 @@ Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -{ - "transactionId": "" -} ``` diff --git a/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md b/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md index 277afbd1..9e3f4803 100644 --- a/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md +++ b/examples/1.9.x/client-rest/examples/tablesdb/delete-row.md @@ -5,7 +5,4 @@ Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -{ - "transactionId": "" -} ``` diff --git a/examples/1.9.x/server-go/examples/databases/create-line-attribute.md b/examples/1.9.x/server-go/examples/databases/create-line-attribute.md index 8bc7a32b..52fef1bd 100644 --- a/examples/1.9.x/server-go/examples/databases/create-line-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-line-attribute.md @@ -20,6 +20,6 @@ response, error := service.CreateLineAttribute( "", "", false, - databases.WithCreateLineAttributeDefault([]interface{}{[1, 2], [3, 4], [5, 6]}), + databases.WithCreateLineAttributeDefault([][]interface{}{[1, 2], [3, 4], [5, 6]}), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/create-point-attribute.md b/examples/1.9.x/server-go/examples/databases/create-point-attribute.md index 0eba7812..d53b87bd 100644 --- a/examples/1.9.x/server-go/examples/databases/create-point-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-point-attribute.md @@ -20,6 +20,6 @@ response, error := service.CreatePointAttribute( "", "", false, - databases.WithCreatePointAttributeDefault([]interface{}{1, 2}), + databases.WithCreatePointAttributeDefault([]float64{1, 2}), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/create-polygon-attribute.md b/examples/1.9.x/server-go/examples/databases/create-polygon-attribute.md index 4835b798..018a901a 100644 --- a/examples/1.9.x/server-go/examples/databases/create-polygon-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/create-polygon-attribute.md @@ -20,6 +20,6 @@ response, error := service.CreatePolygonAttribute( "", "", false, - databases.WithCreatePolygonAttributeDefault([]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), + databases.WithCreatePolygonAttributeDefault([][]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/update-line-attribute.md b/examples/1.9.x/server-go/examples/databases/update-line-attribute.md index 7cae2576..b473e1a8 100644 --- a/examples/1.9.x/server-go/examples/databases/update-line-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-line-attribute.md @@ -20,7 +20,7 @@ response, error := service.UpdateLineAttribute( "", "", false, - databases.WithUpdateLineAttributeDefault([]interface{}{[1, 2], [3, 4], [5, 6]}), + databases.WithUpdateLineAttributeDefault([][]interface{}{[1, 2], [3, 4], [5, 6]}), databases.WithUpdateLineAttributeNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/update-point-attribute.md b/examples/1.9.x/server-go/examples/databases/update-point-attribute.md index 9da605d0..3456b179 100644 --- a/examples/1.9.x/server-go/examples/databases/update-point-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-point-attribute.md @@ -20,7 +20,7 @@ response, error := service.UpdatePointAttribute( "", "", false, - databases.WithUpdatePointAttributeDefault([]interface{}{1, 2}), + databases.WithUpdatePointAttributeDefault([]float64{1, 2}), databases.WithUpdatePointAttributeNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/databases/update-polygon-attribute.md b/examples/1.9.x/server-go/examples/databases/update-polygon-attribute.md index 5db33da8..75b8cc75 100644 --- a/examples/1.9.x/server-go/examples/databases/update-polygon-attribute.md +++ b/examples/1.9.x/server-go/examples/databases/update-polygon-attribute.md @@ -20,7 +20,7 @@ response, error := service.UpdatePolygonAttribute( "", "", false, - databases.WithUpdatePolygonAttributeDefault([]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), + databases.WithUpdatePolygonAttributeDefault([][]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), databases.WithUpdatePolygonAttributeNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-line-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-line-column.md index ec15a1ed..6d2be9ca 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-line-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-line-column.md @@ -20,6 +20,6 @@ response, error := service.CreateLineColumn( "", "", false, - tablesdb.WithCreateLineColumnDefault([]interface{}{[1, 2], [3, 4], [5, 6]}), + tablesdb.WithCreateLineColumnDefault([][]interface{}{[1, 2], [3, 4], [5, 6]}), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-point-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-point-column.md index 18c1c62f..48fa9286 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-point-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-point-column.md @@ -20,6 +20,6 @@ response, error := service.CreatePointColumn( "", "", false, - tablesdb.WithCreatePointColumnDefault([]interface{}{1, 2}), + tablesdb.WithCreatePointColumnDefault([]float64{1, 2}), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/create-polygon-column.md b/examples/1.9.x/server-go/examples/tablesdb/create-polygon-column.md index 305a8403..498d2339 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/create-polygon-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/create-polygon-column.md @@ -20,6 +20,6 @@ response, error := service.CreatePolygonColumn( "", "", false, - tablesdb.WithCreatePolygonColumnDefault([]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), + tablesdb.WithCreatePolygonColumnDefault([][]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-line-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-line-column.md index 78653fbd..c46e48b8 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-line-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-line-column.md @@ -20,7 +20,7 @@ response, error := service.UpdateLineColumn( "", "", false, - tablesdb.WithUpdateLineColumnDefault([]interface{}{[1, 2], [3, 4], [5, 6]}), + tablesdb.WithUpdateLineColumnDefault([][]interface{}{[1, 2], [3, 4], [5, 6]}), tablesdb.WithUpdateLineColumnNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-point-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-point-column.md index 3b128bd7..29abcebf 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-point-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-point-column.md @@ -20,7 +20,7 @@ response, error := service.UpdatePointColumn( "", "", false, - tablesdb.WithUpdatePointColumnDefault([]interface{}{1, 2}), + tablesdb.WithUpdatePointColumnDefault([]float64{1, 2}), tablesdb.WithUpdatePointColumnNewKey(""), ) ``` diff --git a/examples/1.9.x/server-go/examples/tablesdb/update-polygon-column.md b/examples/1.9.x/server-go/examples/tablesdb/update-polygon-column.md index d0c81adb..da3f1aed 100644 --- a/examples/1.9.x/server-go/examples/tablesdb/update-polygon-column.md +++ b/examples/1.9.x/server-go/examples/tablesdb/update-polygon-column.md @@ -20,7 +20,7 @@ response, error := service.UpdatePolygonColumn( "", "", false, - tablesdb.WithUpdatePolygonColumnDefault([]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), + tablesdb.WithUpdatePolygonColumnDefault([][]interface{}{[[1, 2], [3, 4], [5, 6], [1, 2]]}), tablesdb.WithUpdatePolygonColumnNewKey(""), ) ``` diff --git a/examples/1.9.x/server-graphql/examples/backups/create-policy.md b/examples/1.9.x/server-graphql/examples/backups/create-policy.md index 7c84b13b..97685ebd 100644 --- a/examples/1.9.x/server-graphql/examples/backups/create-policy.md +++ b/examples/1.9.x/server-graphql/examples/backups/create-policy.md @@ -19,6 +19,7 @@ mutation { resourceType retention schedule + type enabled } } @@ -42,6 +43,7 @@ mutation { resourceType retention schedule + type enabled } } diff --git a/examples/1.9.x/server-graphql/examples/backups/get-policy.md b/examples/1.9.x/server-graphql/examples/backups/get-policy.md index f5b45ea2..72d33fdc 100644 --- a/examples/1.9.x/server-graphql/examples/backups/get-policy.md +++ b/examples/1.9.x/server-graphql/examples/backups/get-policy.md @@ -13,6 +13,7 @@ query { resourceType retention schedule + type enabled } } diff --git a/examples/1.9.x/server-graphql/examples/backups/list-policies.md b/examples/1.9.x/server-graphql/examples/backups/list-policies.md index a10dceb3..d1025015 100644 --- a/examples/1.9.x/server-graphql/examples/backups/list-policies.md +++ b/examples/1.9.x/server-graphql/examples/backups/list-policies.md @@ -15,6 +15,7 @@ query { resourceType retention schedule + type enabled } } diff --git a/examples/1.9.x/server-graphql/examples/backups/update-policy.md b/examples/1.9.x/server-graphql/examples/backups/update-policy.md index c1593583..716dd8de 100644 --- a/examples/1.9.x/server-graphql/examples/backups/update-policy.md +++ b/examples/1.9.x/server-graphql/examples/backups/update-policy.md @@ -17,6 +17,7 @@ mutation { resourceType retention schedule + type enabled } } @@ -38,6 +39,7 @@ mutation { resourceType retention schedule + type enabled } } diff --git a/examples/1.9.x/server-graphql/examples/databases/create.md b/examples/1.9.x/server-graphql/examples/databases/create.md index 7e1b86cb..1675ee16 100644 --- a/examples/1.9.x/server-graphql/examples/databases/create.md +++ b/examples/1.9.x/server-graphql/examples/databases/create.md @@ -22,6 +22,7 @@ mutation { resourceType retention schedule + type enabled } archives { @@ -63,6 +64,7 @@ mutation { resourceType retention schedule + type enabled } archives { diff --git a/examples/1.9.x/server-graphql/examples/databases/get.md b/examples/1.9.x/server-graphql/examples/databases/get.md index 31c3a4d6..452f8397 100644 --- a/examples/1.9.x/server-graphql/examples/databases/get.md +++ b/examples/1.9.x/server-graphql/examples/databases/get.md @@ -20,6 +20,7 @@ query { resourceType retention schedule + type enabled } archives { diff --git a/examples/1.9.x/server-graphql/examples/databases/list.md b/examples/1.9.x/server-graphql/examples/databases/list.md index f9e43f5d..ae7f82ea 100644 --- a/examples/1.9.x/server-graphql/examples/databases/list.md +++ b/examples/1.9.x/server-graphql/examples/databases/list.md @@ -24,6 +24,7 @@ query { resourceType retention schedule + type enabled } archives { diff --git a/examples/1.9.x/server-graphql/examples/databases/update.md b/examples/1.9.x/server-graphql/examples/databases/update.md index 8aa2da86..a1220e8b 100644 --- a/examples/1.9.x/server-graphql/examples/databases/update.md +++ b/examples/1.9.x/server-graphql/examples/databases/update.md @@ -22,6 +22,7 @@ mutation { resourceType retention schedule + type enabled } archives { @@ -63,6 +64,7 @@ mutation { resourceType retention schedule + type enabled } archives { diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/create.md b/examples/1.9.x/server-graphql/examples/tablesdb/create.md index c5689377..bb2e6974 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/create.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/create.md @@ -23,6 +23,7 @@ mutation { resourceType retention schedule + type enabled } archives { @@ -65,6 +66,7 @@ mutation { resourceType retention schedule + type enabled } archives { diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/get.md b/examples/1.9.x/server-graphql/examples/tablesdb/get.md index 3bad885e..ccb444b1 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/get.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/get.md @@ -20,6 +20,7 @@ query { resourceType retention schedule + type enabled } archives { diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/list.md b/examples/1.9.x/server-graphql/examples/tablesdb/list.md index 4111a783..9b527d69 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/list.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/list.md @@ -24,6 +24,7 @@ query { resourceType retention schedule + type enabled } archives { diff --git a/examples/1.9.x/server-graphql/examples/tablesdb/update.md b/examples/1.9.x/server-graphql/examples/tablesdb/update.md index e82d10ec..02dd4e01 100644 --- a/examples/1.9.x/server-graphql/examples/tablesdb/update.md +++ b/examples/1.9.x/server-graphql/examples/tablesdb/update.md @@ -22,6 +22,7 @@ mutation { resourceType retention schedule + type enabled } archives { @@ -63,6 +64,7 @@ mutation { resourceType retention schedule + type enabled } archives { diff --git a/examples/1.9.x/server-rest/examples/databases/delete-document.md b/examples/1.9.x/server-rest/examples/databases/delete-document.md index a4472d07..eeb3394e 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-document.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-document.md @@ -5,7 +5,4 @@ Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -{ - "transactionId": "" -} ``` diff --git a/examples/1.9.x/server-rest/examples/databases/delete-documents.md b/examples/1.9.x/server-rest/examples/databases/delete-documents.md index aa7b5973..3fb41abc 100644 --- a/examples/1.9.x/server-rest/examples/databases/delete-documents.md +++ b/examples/1.9.x/server-rest/examples/databases/delete-documents.md @@ -6,13 +6,5 @@ Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -{ - "queries": [], - "transactionId": "" -} -{ - "queries": [], - "transactionId": "" -} ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md index 277afbd1..9e3f4803 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-row.md @@ -5,7 +5,4 @@ Content-Type: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -{ - "transactionId": "" -} ``` diff --git a/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md b/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md index fff623bb..d9063945 100644 --- a/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md +++ b/examples/1.9.x/server-rest/examples/tablesdb/delete-rows.md @@ -6,13 +6,5 @@ Accept: application/json X-Appwrite-Response-Format: 1.9.5 X-Appwrite-Project: -{ - "queries": [], - "transactionId": "" -} -{ - "queries": [], - "transactionId": "" -} ``` diff --git a/specs/1.9.x/open-api3-1.9.x-client.json b/specs/1.9.x/open-api3-1.9.x-client.json index 4ba14767..b8a34195 100644 --- a/specs/1.9.x/open-api3-1.9.x-client.json +++ b/specs/1.9.x/open-api3-1.9.x-client.json @@ -726,7 +726,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -852,7 +855,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -984,7 +990,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -1113,7 +1122,13 @@ "totp", "recoverycode" ], - "x-enum-name": "AuthenticationFactor" + "x-enum-name": "AuthenticationFactor", + "x-enum-keys": [ + "email", + "phone", + "totp", + "recoverycode" + ] } }, "required": [ @@ -1994,6 +2009,7 @@ "prefs": { "type": "object", "description": "Prefs key-value JSON object.", + "default": {}, "x-example": "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}" } }, @@ -2490,7 +2506,15 @@ "description": "Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n", "responses": { "301": { - "description": "File" + "description": "No content", + "content": { + "text\/html": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -2576,7 +2600,52 @@ "zoho", "zoom" ], - "x-enum-name": "OAuthProvider" + "x-enum-name": "OAuthProvider", + "x-enum-keys": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom" + ] }, "in": "path" }, @@ -3432,7 +3501,15 @@ "description": "Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).", "responses": { "301": { - "description": "File" + "description": "No content", + "content": { + "text\/html": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -3518,7 +3595,52 @@ "zoho", "zoom" ], - "x-enum-name": "OAuthProvider" + "x-enum-name": "OAuthProvider", + "x-enum-keys": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom" + ] }, "in": "path" }, @@ -4065,7 +4187,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4141,7 +4262,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4297,7 +4417,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4359,7 +4478,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4503,11 +4621,13 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -4567,7 +4687,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4653,7 +4772,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4717,7 +4835,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4782,11 +4899,13 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -4856,7 +4975,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4932,11 +5050,13 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -4972,7 +5092,15 @@ "description": "You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -4989,7 +5117,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5101,7 +5228,15 @@ "description": "The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5118,7 +5253,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5236,7 +5370,15 @@ "description": "Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n\nThis endpoint does not follow HTTP redirects.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5253,7 +5395,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5297,7 +5438,15 @@ "description": "You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5314,7 +5463,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5788,7 +5936,15 @@ "description": "Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n\nThis endpoint does not follow HTTP redirects.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5805,7 +5961,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5873,7 +6028,15 @@ "description": "Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5890,7 +6053,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5968,7 +6130,15 @@ "description": "Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5985,7 +6155,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -6063,7 +6232,15 @@ "description": "Use this endpoint to capture a screenshot of any website URL. This endpoint uses a headless browser to render the webpage and capture it as an image.\n\nYou can configure the browser viewport size, theme, user agent, geolocation, permissions, and more. Capture either just the viewport or the full page scroll.\n\nWhen width and height are specified, the image is resized accordingly. If both dimensions are 0, the API provides an image at original size. If dimensions are not specified, the default viewport size is 1280x720px.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -6080,7 +6257,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -6117,8 +6293,8 @@ "required": false, "schema": { "type": "object", - "x-example": "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}", - "default": {} + "default": [], + "x-example": "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}" }, "in": "query" }, @@ -6170,6 +6346,10 @@ "dark" ], "x-enum-name": "BrowserTheme", + "x-enum-keys": [ + "light", + "dark" + ], "default": "light" }, "in": "query" @@ -6635,88 +6815,531 @@ "pacific\/wallis", "utc" ], - "x-enum-name": "Timezone" - }, - "in": "query" - }, - { - "name": "latitude", - "description": "Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.", - "required": false, - "schema": { - "type": "number", - "format": "float", - "x-example": "37.7749", - "default": 0 - }, - "in": "query" - }, - { - "name": "longitude", - "description": "Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.", - "required": false, - "schema": { - "type": "number", - "format": "float", - "x-example": "-122.4194", - "default": 0 - }, - "in": "query" - }, - { - "name": "accuracy", - "description": "Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.", - "required": false, - "schema": { - "type": "number", - "format": "float", - "x-example": "100", - "default": 0 - }, - "in": "query" - }, - { - "name": "touch", - "description": "Enable touch support. Pass 0 for no touch, or 1 for touch enabled. Defaults to 0.", - "required": false, - "schema": { - "type": "boolean", - "x-example": "true", - "default": false - }, - "in": "query" - }, - { - "name": "permissions", - "description": "Browser permissions to grant. Pass an array of permission names like [\"geolocation\", \"camera\", \"microphone\"]. Defaults to empty.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "geolocation", - "camera", - "microphone", - "notifications", - "midi", - "push", - "clipboard-read", - "clipboard-write", - "payment-handler", - "usb", - "bluetooth", - "accelerometer", - "gyroscope", - "magnetometer", - "ambient-light-sensor", - "background-sync", - "persistent-storage", + "x-enum-name": "Timezone", + "x-enum-keys": [ + "africa\/abidjan", + "africa\/accra", + "africa\/addis_ababa", + "africa\/algiers", + "africa\/asmara", + "africa\/bamako", + "africa\/bangui", + "africa\/banjul", + "africa\/bissau", + "africa\/blantyre", + "africa\/brazzaville", + "africa\/bujumbura", + "africa\/cairo", + "africa\/casablanca", + "africa\/ceuta", + "africa\/conakry", + "africa\/dakar", + "africa\/dar_es_salaam", + "africa\/djibouti", + "africa\/douala", + "africa\/el_aaiun", + "africa\/freetown", + "africa\/gaborone", + "africa\/harare", + "africa\/johannesburg", + "africa\/juba", + "africa\/kampala", + "africa\/khartoum", + "africa\/kigali", + "africa\/kinshasa", + "africa\/lagos", + "africa\/libreville", + "africa\/lome", + "africa\/luanda", + "africa\/lubumbashi", + "africa\/lusaka", + "africa\/malabo", + "africa\/maputo", + "africa\/maseru", + "africa\/mbabane", + "africa\/mogadishu", + "africa\/monrovia", + "africa\/nairobi", + "africa\/ndjamena", + "africa\/niamey", + "africa\/nouakchott", + "africa\/ouagadougou", + "africa\/porto-novo", + "africa\/sao_tome", + "africa\/tripoli", + "africa\/tunis", + "africa\/windhoek", + "america\/adak", + "america\/anchorage", + "america\/anguilla", + "america\/antigua", + "america\/araguaina", + "america\/argentina\/buenos_aires", + "america\/argentina\/catamarca", + "america\/argentina\/cordoba", + "america\/argentina\/jujuy", + "america\/argentina\/la_rioja", + "america\/argentina\/mendoza", + "america\/argentina\/rio_gallegos", + "america\/argentina\/salta", + "america\/argentina\/san_juan", + "america\/argentina\/san_luis", + "america\/argentina\/tucuman", + "america\/argentina\/ushuaia", + "america\/aruba", + "america\/asuncion", + "america\/atikokan", + "america\/bahia", + "america\/bahia_banderas", + "america\/barbados", + "america\/belem", + "america\/belize", + "america\/blanc-sablon", + "america\/boa_vista", + "america\/bogota", + "america\/boise", + "america\/cambridge_bay", + "america\/campo_grande", + "america\/cancun", + "america\/caracas", + "america\/cayenne", + "america\/cayman", + "america\/chicago", + "america\/chihuahua", + "america\/ciudad_juarez", + "america\/costa_rica", + "america\/coyhaique", + "america\/creston", + "america\/cuiaba", + "america\/curacao", + "america\/danmarkshavn", + "america\/dawson", + "america\/dawson_creek", + "america\/denver", + "america\/detroit", + "america\/dominica", + "america\/edmonton", + "america\/eirunepe", + "america\/el_salvador", + "america\/fort_nelson", + "america\/fortaleza", + "america\/glace_bay", + "america\/goose_bay", + "america\/grand_turk", + "america\/grenada", + "america\/guadeloupe", + "america\/guatemala", + "america\/guayaquil", + "america\/guyana", + "america\/halifax", + "america\/havana", + "america\/hermosillo", + "america\/indiana\/indianapolis", + "america\/indiana\/knox", + "america\/indiana\/marengo", + "america\/indiana\/petersburg", + "america\/indiana\/tell_city", + "america\/indiana\/vevay", + "america\/indiana\/vincennes", + "america\/indiana\/winamac", + "america\/inuvik", + "america\/iqaluit", + "america\/jamaica", + "america\/juneau", + "america\/kentucky\/louisville", + "america\/kentucky\/monticello", + "america\/kralendijk", + "america\/la_paz", + "america\/lima", + "america\/los_angeles", + "america\/lower_princes", + "america\/maceio", + "america\/managua", + "america\/manaus", + "america\/marigot", + "america\/martinique", + "america\/matamoros", + "america\/mazatlan", + "america\/menominee", + "america\/merida", + "america\/metlakatla", + "america\/mexico_city", + "america\/miquelon", + "america\/moncton", + "america\/monterrey", + "america\/montevideo", + "america\/montserrat", + "america\/nassau", + "america\/new_york", + "america\/nome", + "america\/noronha", + "america\/north_dakota\/beulah", + "america\/north_dakota\/center", + "america\/north_dakota\/new_salem", + "america\/nuuk", + "america\/ojinaga", + "america\/panama", + "america\/paramaribo", + "america\/phoenix", + "america\/port-au-prince", + "america\/port_of_spain", + "america\/porto_velho", + "america\/puerto_rico", + "america\/punta_arenas", + "america\/rankin_inlet", + "america\/recife", + "america\/regina", + "america\/resolute", + "america\/rio_branco", + "america\/santarem", + "america\/santiago", + "america\/santo_domingo", + "america\/sao_paulo", + "america\/scoresbysund", + "america\/sitka", + "america\/st_barthelemy", + "america\/st_johns", + "america\/st_kitts", + "america\/st_lucia", + "america\/st_thomas", + "america\/st_vincent", + "america\/swift_current", + "america\/tegucigalpa", + "america\/thule", + "america\/tijuana", + "america\/toronto", + "america\/tortola", + "america\/vancouver", + "america\/whitehorse", + "america\/winnipeg", + "america\/yakutat", + "antarctica\/casey", + "antarctica\/davis", + "antarctica\/dumontdurville", + "antarctica\/macquarie", + "antarctica\/mawson", + "antarctica\/mcmurdo", + "antarctica\/palmer", + "antarctica\/rothera", + "antarctica\/syowa", + "antarctica\/troll", + "antarctica\/vostok", + "arctic\/longyearbyen", + "asia\/aden", + "asia\/almaty", + "asia\/amman", + "asia\/anadyr", + "asia\/aqtau", + "asia\/aqtobe", + "asia\/ashgabat", + "asia\/atyrau", + "asia\/baghdad", + "asia\/bahrain", + "asia\/baku", + "asia\/bangkok", + "asia\/barnaul", + "asia\/beirut", + "asia\/bishkek", + "asia\/brunei", + "asia\/chita", + "asia\/colombo", + "asia\/damascus", + "asia\/dhaka", + "asia\/dili", + "asia\/dubai", + "asia\/dushanbe", + "asia\/famagusta", + "asia\/gaza", + "asia\/hebron", + "asia\/ho_chi_minh", + "asia\/hong_kong", + "asia\/hovd", + "asia\/irkutsk", + "asia\/jakarta", + "asia\/jayapura", + "asia\/jerusalem", + "asia\/kabul", + "asia\/kamchatka", + "asia\/karachi", + "asia\/kathmandu", + "asia\/khandyga", + "asia\/kolkata", + "asia\/krasnoyarsk", + "asia\/kuala_lumpur", + "asia\/kuching", + "asia\/kuwait", + "asia\/macau", + "asia\/magadan", + "asia\/makassar", + "asia\/manila", + "asia\/muscat", + "asia\/nicosia", + "asia\/novokuznetsk", + "asia\/novosibirsk", + "asia\/omsk", + "asia\/oral", + "asia\/phnom_penh", + "asia\/pontianak", + "asia\/pyongyang", + "asia\/qatar", + "asia\/qostanay", + "asia\/qyzylorda", + "asia\/riyadh", + "asia\/sakhalin", + "asia\/samarkand", + "asia\/seoul", + "asia\/shanghai", + "asia\/singapore", + "asia\/srednekolymsk", + "asia\/taipei", + "asia\/tashkent", + "asia\/tbilisi", + "asia\/tehran", + "asia\/thimphu", + "asia\/tokyo", + "asia\/tomsk", + "asia\/ulaanbaatar", + "asia\/urumqi", + "asia\/ust-nera", + "asia\/vientiane", + "asia\/vladivostok", + "asia\/yakutsk", + "asia\/yangon", + "asia\/yekaterinburg", + "asia\/yerevan", + "atlantic\/azores", + "atlantic\/bermuda", + "atlantic\/canary", + "atlantic\/cape_verde", + "atlantic\/faroe", + "atlantic\/madeira", + "atlantic\/reykjavik", + "atlantic\/south_georgia", + "atlantic\/st_helena", + "atlantic\/stanley", + "australia\/adelaide", + "australia\/brisbane", + "australia\/broken_hill", + "australia\/darwin", + "australia\/eucla", + "australia\/hobart", + "australia\/lindeman", + "australia\/lord_howe", + "australia\/melbourne", + "australia\/perth", + "australia\/sydney", + "europe\/amsterdam", + "europe\/andorra", + "europe\/astrakhan", + "europe\/athens", + "europe\/belgrade", + "europe\/berlin", + "europe\/bratislava", + "europe\/brussels", + "europe\/bucharest", + "europe\/budapest", + "europe\/busingen", + "europe\/chisinau", + "europe\/copenhagen", + "europe\/dublin", + "europe\/gibraltar", + "europe\/guernsey", + "europe\/helsinki", + "europe\/isle_of_man", + "europe\/istanbul", + "europe\/jersey", + "europe\/kaliningrad", + "europe\/kirov", + "europe\/kyiv", + "europe\/lisbon", + "europe\/ljubljana", + "europe\/london", + "europe\/luxembourg", + "europe\/madrid", + "europe\/malta", + "europe\/mariehamn", + "europe\/minsk", + "europe\/monaco", + "europe\/moscow", + "europe\/oslo", + "europe\/paris", + "europe\/podgorica", + "europe\/prague", + "europe\/riga", + "europe\/rome", + "europe\/samara", + "europe\/san_marino", + "europe\/sarajevo", + "europe\/saratov", + "europe\/simferopol", + "europe\/skopje", + "europe\/sofia", + "europe\/stockholm", + "europe\/tallinn", + "europe\/tirane", + "europe\/ulyanovsk", + "europe\/vaduz", + "europe\/vatican", + "europe\/vienna", + "europe\/vilnius", + "europe\/volgograd", + "europe\/warsaw", + "europe\/zagreb", + "europe\/zurich", + "indian\/antananarivo", + "indian\/chagos", + "indian\/christmas", + "indian\/cocos", + "indian\/comoro", + "indian\/kerguelen", + "indian\/mahe", + "indian\/maldives", + "indian\/mauritius", + "indian\/mayotte", + "indian\/reunion", + "pacific\/apia", + "pacific\/auckland", + "pacific\/bougainville", + "pacific\/chatham", + "pacific\/chuuk", + "pacific\/easter", + "pacific\/efate", + "pacific\/fakaofo", + "pacific\/fiji", + "pacific\/funafuti", + "pacific\/galapagos", + "pacific\/gambier", + "pacific\/guadalcanal", + "pacific\/guam", + "pacific\/honolulu", + "pacific\/kanton", + "pacific\/kiritimati", + "pacific\/kosrae", + "pacific\/kwajalein", + "pacific\/majuro", + "pacific\/marquesas", + "pacific\/midway", + "pacific\/nauru", + "pacific\/niue", + "pacific\/norfolk", + "pacific\/noumea", + "pacific\/pago_pago", + "pacific\/palau", + "pacific\/pitcairn", + "pacific\/pohnpei", + "pacific\/port_moresby", + "pacific\/rarotonga", + "pacific\/saipan", + "pacific\/tahiti", + "pacific\/tarawa", + "pacific\/tongatapu", + "pacific\/wake", + "pacific\/wallis", + "utc" + ] + }, + "in": "query" + }, + { + "name": "latitude", + "description": "Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.", + "required": false, + "schema": { + "type": "number", + "format": "float", + "x-example": "37.7749", + "default": 0 + }, + "in": "query" + }, + { + "name": "longitude", + "description": "Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.", + "required": false, + "schema": { + "type": "number", + "format": "float", + "x-example": "-122.4194", + "default": 0 + }, + "in": "query" + }, + { + "name": "accuracy", + "description": "Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.", + "required": false, + "schema": { + "type": "number", + "format": "float", + "x-example": "100", + "default": 0 + }, + "in": "query" + }, + { + "name": "touch", + "description": "Enable touch support. Pass 0 for no touch, or 1 for touch enabled. Defaults to 0.", + "required": false, + "schema": { + "type": "boolean", + "x-example": "true", + "default": false + }, + "in": "query" + }, + { + "name": "permissions", + "description": "Browser permissions to grant. Pass an array of permission names like [\"geolocation\", \"camera\", \"microphone\"]. Defaults to empty.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "geolocation", + "camera", + "microphone", + "notifications", + "midi", + "push", + "clipboard-read", + "clipboard-write", + "payment-handler", + "usb", + "bluetooth", + "accelerometer", + "gyroscope", + "magnetometer", + "ambient-light-sensor", + "background-sync", + "persistent-storage", "screen-wake-lock", "web-share", "xr-spatial-tracking" ], - "x-enum-name": "BrowserPermission" + "x-enum-name": "BrowserPermission", + "x-enum-keys": [ + "geolocation", + "camera", + "microphone", + "notifications", + "midi", + "push", + "clipboard-read", + "clipboard-write", + "payment-handler", + "usb", + "bluetooth", + "accelerometer", + "gyroscope", + "magnetometer", + "ambient-light-sensor", + "background-sync", + "persistent-storage", + "screen-wake-lock", + "web-share", + "xr-spatial-tracking" + ] }, "x-example": "[\"geolocation\",\"notifications\"]", "default": [] @@ -6787,7 +7410,16 @@ "avif", "gif" ], - "x-enum-name": "ImageFormat" + "x-enum-name": "ImageFormat", + "x-enum-keys": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ] }, "in": "query" } @@ -6828,8 +7460,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -6894,8 +7525,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -6965,8 +7595,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -7028,8 +7657,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -7107,8 +7735,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -7172,8 +7799,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -7257,7 +7883,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7380,7 +8005,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7478,7 +8102,7 @@ "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -7546,7 +8170,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7656,7 +8279,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7757,7 +8379,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -7814,7 +8436,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7876,7 +8497,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "permissions": { @@ -7926,7 +8547,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7977,25 +8597,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { @@ -8032,8 +8645,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -8161,8 +8773,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -8290,8 +8901,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -8356,8 +8966,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -8427,8 +9036,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -8490,8 +9098,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -8569,8 +9176,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -8633,8 +9239,7 @@ "scope": "documents.write", "platforms": [ "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -8718,7 +9323,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -8837,7 +9441,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -8953,7 +9556,7 @@ "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -9019,7 +9622,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -9125,7 +9727,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -9215,7 +9816,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -9270,7 +9871,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -9328,7 +9928,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -9376,7 +9976,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -9423,24 +10022,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } + ] } }, "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { @@ -9477,8 +10070,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -9600,8 +10192,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -9726,7 +10317,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -9815,7 +10405,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -9881,12 +10470,21 @@ "OPTIONS", "HEAD" ], - "x-enum-name": "ExecutionMethod" + "x-enum-name": "ExecutionMethod", + "x-enum-keys": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ] }, "headers": { "type": "object", "description": "HTTP headers of execution. Defaults to empty.", - "default": {}, + "default": [], "x-example": "{}" }, "scheduledAt": { @@ -9939,7 +10537,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -10013,8 +10610,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -10029,7 +10625,27 @@ "Session": [], "JWT": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "type": "object", + "description": "The query or queries to execute.", + "default": {}, + "x-example": "{}" + } + }, + "required": [ + "query" + ] + } + } + } + } } }, "\/graphql\/mutation": { @@ -10066,8 +10682,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -10082,7 +10697,27 @@ "Session": [], "JWT": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "type": "object", + "description": "The query or queries to execute.", + "default": {}, + "x-example": "{}" + } + }, + "required": [ + "query" + ] + } + } + } + } } }, "\/locale": { @@ -10119,7 +10754,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -10172,7 +10806,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -10225,7 +10858,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -10278,7 +10910,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -10331,7 +10962,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -10384,7 +11014,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -10437,7 +11066,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -10490,7 +11118,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -10543,8 +11170,7 @@ "platforms": [ "server", "client", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -10629,8 +11255,7 @@ "platforms": [ "server", "client", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -11051,7 +11676,6 @@ "scope": "oauth2.read", "platforms": [ "client", - "server", "server" ], "packaging": false, @@ -11206,8 +11830,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -11297,8 +11920,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -11449,7 +12071,7 @@ "metadata": { "type": "object", "description": "Presence metadata object.", - "default": {}, + "default": [], "x-example": "{}" } }, @@ -11575,6 +12197,7 @@ "metadata": { "type": "object", "description": "Presence metadata object.", + "default": {}, "x-example": "{}" }, "permissions": { @@ -11623,8 +12246,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -11688,7 +12310,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -11786,7 +12407,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -11890,7 +12510,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -11963,7 +12582,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -12054,7 +12672,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -12105,7 +12722,15 @@ "description": "Get a file 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.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "*\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -12122,7 +12747,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -12186,7 +12810,15 @@ "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -12203,7 +12835,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -12286,6 +12917,17 @@ "bottom-right" ], "x-enum-name": "ImageGravity", + "x-enum-keys": [ + "center", + "top-left", + "top", + "top-right", + "left", + "right", + "bottom-left", + "bottom", + "bottom-right" + ], "default": "center" }, "in": "query" @@ -12386,7 +13028,16 @@ "avif", "gif" ], - "x-enum-name": "ImageFormat" + "x-enum-name": "ImageFormat", + "x-enum-keys": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ] }, "in": "query" }, @@ -12414,7 +13065,15 @@ "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "*\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -12431,7 +13090,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -12522,8 +13180,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -12591,8 +13248,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -12665,8 +13321,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -12731,8 +13386,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -12813,8 +13467,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -12881,8 +13534,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -12969,7 +13621,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -13091,7 +13742,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -13181,7 +13831,7 @@ "data": { "type": "object", "description": "Row data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -13252,7 +13902,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -13361,7 +14010,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -13451,7 +14099,7 @@ "data": { "type": "object", "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "permissions": { @@ -13511,7 +14159,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -13569,7 +14216,7 @@ "data": { "type": "object", "description": "Row data as JSON object. Include only columns and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "permissions": { @@ -13622,7 +14269,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -13669,25 +14315,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { @@ -13727,8 +14366,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -13855,8 +14493,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -13980,7 +14617,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14068,7 +14704,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14160,7 +14795,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14223,7 +14857,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14298,7 +14931,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14363,7 +14995,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14461,7 +15092,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14581,7 +15211,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14654,7 +15283,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14742,7 +15370,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -15015,6 +15642,7 @@ "prefs": { "type": "object", "description": "Prefs key-value JSON object.", + "default": {}, "x-example": "{}" } }, @@ -15061,8 +15689,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -15127,8 +15754,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -15198,8 +15824,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -15261,8 +15886,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -15340,8 +15964,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -15405,8 +16028,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -15490,7 +16112,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -15609,7 +16230,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -15698,7 +16318,7 @@ "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" }, "permissions": { @@ -15764,7 +16384,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -15870,7 +16489,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -15963,7 +16581,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -16018,7 +16636,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -16076,7 +16693,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -16124,7 +16741,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -16171,24 +16787,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } + ] } } }, @@ -16274,44 +16884,6 @@ "additionalProperties": true, "example": [] }, - "error": { - "description": "Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Error message.", - "x-example": "Not found" - }, - "code": { - "type": "string", - "description": "Error code.", - "x-example": "404" - }, - "type": { - "type": "string", - "description": "Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes", - "x-example": "not_found" - }, - "version": { - "type": "string", - "description": "Server version number.", - "x-example": "1.0" - } - }, - "required": [ - "message", - "code", - "type", - "version" - ], - "example": { - "message": "Not found", - "code": "404", - "type": "not_found", - "version": "1.0" - } - }, "rowList": { "description": "Rows List", "type": "object", @@ -16986,11 +17558,11 @@ }, "metadata": { "type": "object", + "additionalProperties": true, "description": "Presence metadata.", "x-example": { "key": "value" - }, - "nullable": true + } } }, "required": [ @@ -17221,43 +17793,45 @@ "type": "object", "description": "Password hashing algorithm configuration.", "x-example": {}, - "items": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/algoArgon2" - }, - { - "$ref": "#\/components\/schemas\/algoScrypt" - }, - { - "$ref": "#\/components\/schemas\/algoScryptModified" - }, - { - "$ref": "#\/components\/schemas\/algoBcrypt" - }, - { - "$ref": "#\/components\/schemas\/algoPhpass" - }, - { - "$ref": "#\/components\/schemas\/algoSha" - }, - { - "$ref": "#\/components\/schemas\/algoMd5" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "argon2": "#\/components\/schemas\/algoArgon2", - "scrypt": "#\/components\/schemas\/algoScrypt", - "scryptMod": "#\/components\/schemas\/algoScryptModified", - "bcrypt": "#\/components\/schemas\/algoBcrypt", - "phpass": "#\/components\/schemas\/algoPhpass", - "sha": "#\/components\/schemas\/algoSha", - "md5": "#\/components\/schemas\/algoMd5" + "allOf": [ + { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/algoArgon2" + }, + { + "$ref": "#\/components\/schemas\/algoScrypt" + }, + { + "$ref": "#\/components\/schemas\/algoScryptModified" + }, + { + "$ref": "#\/components\/schemas\/algoBcrypt" + }, + { + "$ref": "#\/components\/schemas\/algoPhpass" + }, + { + "$ref": "#\/components\/schemas\/algoSha" + }, + { + "$ref": "#\/components\/schemas\/algoMd5" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "argon2": "#\/components\/schemas\/algoArgon2", + "scrypt": "#\/components\/schemas\/algoScrypt", + "scryptMod": "#\/components\/schemas\/algoScryptModified", + "bcrypt": "#\/components\/schemas\/algoBcrypt", + "phpass": "#\/components\/schemas\/algoPhpass", + "sha": "#\/components\/schemas\/algoSha", + "md5": "#\/components\/schemas\/algoMd5" + } } } - }, + ], "nullable": true }, "registration": { @@ -17347,9 +17921,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "$ref": "#\/components\/schemas\/preferences" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/preferences" + } + ] }, "targets": { "type": "array", @@ -18243,9 +18819,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "$ref": "#\/components\/schemas\/preferences" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/preferences" + } + ] } }, "required": [ @@ -18980,9 +19558,11 @@ "identifier": "random-mail@email.org", "userId": "5e5ea5c16897e" }, - "items": { - "$ref": "#\/components\/schemas\/target" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/target" + } + ] }, "userId": { "type": "string", diff --git a/specs/1.9.x/open-api3-1.9.x-console.json b/specs/1.9.x/open-api3-1.9.x-console.json index b5d16944..fc2e2909 100644 --- a/specs/1.9.x/open-api3-1.9.x-console.json +++ b/specs/1.9.x/open-api3-1.9.x-console.json @@ -568,6 +568,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/account\/delete-billing-address.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -1123,7 +1126,12 @@ "teams.read", "teams.write" ], - "x-enum-name": "AccountKeyScopes" + "x-enum-name": "AccountKeyScopes", + "x-enum-keys": [ + "account", + "teams.read", + "teams.write" + ] } }, "expire": { @@ -1280,7 +1288,12 @@ "teams.read", "teams.write" ], - "x-enum-name": "AccountKeyScopes" + "x-enum-name": "AccountKeyScopes", + "x-enum-keys": [ + "account", + "teams.read", + "teams.write" + ] } }, "expire": { @@ -1328,6 +1341,9 @@ ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -1617,7 +1633,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -1743,7 +1762,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -1875,7 +1897,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -2004,7 +2029,13 @@ "totp", "recoverycode" ], - "x-enum-name": "AuthenticationFactor" + "x-enum-name": "AuthenticationFactor", + "x-enum-keys": [ + "email", + "phone", + "totp", + "recoverycode" + ] } }, "required": [ @@ -2984,6 +3015,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/account\/delete-payment-method.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -3346,6 +3380,7 @@ "prefs": { "type": "object", "description": "Prefs key-value JSON object.", + "default": {}, "x-example": "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}" } }, @@ -3842,7 +3877,15 @@ "description": "Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n", "responses": { "301": { - "description": "File" + "description": "No content", + "content": { + "text\/html": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -3928,7 +3971,52 @@ "zoho", "zoom" ], - "x-enum-name": "OAuthProvider" + "x-enum-name": "OAuthProvider", + "x-enum-keys": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom" + ] }, "in": "path" }, @@ -4784,7 +4872,15 @@ "description": "Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).", "responses": { "301": { - "description": "File" + "description": "No content", + "content": { + "text\/html": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -4870,7 +4966,52 @@ "zoho", "zoom" ], - "x-enum-name": "OAuthProvider" + "x-enum-name": "OAuthProvider", + "x-enum-keys": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom" + ] }, "in": "path" }, @@ -5541,7 +5682,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5618,7 +5758,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5775,7 +5914,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5838,7 +5976,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5983,11 +6120,13 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -6048,7 +6187,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -6135,7 +6273,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -6200,7 +6337,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -6266,11 +6402,13 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -6341,7 +6479,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -6418,11 +6555,13 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -6459,7 +6598,15 @@ "description": "You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -6476,7 +6623,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -6589,7 +6735,15 @@ "description": "The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -6606,7 +6760,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -6725,7 +6878,15 @@ "description": "Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n\nThis endpoint does not follow HTTP redirects.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -6742,7 +6903,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -6787,7 +6947,15 @@ "description": "You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -6804,7 +6972,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7279,7 +7446,15 @@ "description": "Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n\nThis endpoint does not follow HTTP redirects.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -7296,7 +7471,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7365,7 +7539,15 @@ "description": "Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -7382,7 +7564,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7461,7 +7642,15 @@ "description": "Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -7478,7 +7667,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7557,7 +7745,15 @@ "description": "Use this endpoint to capture a screenshot of any website URL. This endpoint uses a headless browser to render the webpage and capture it as an image.\n\nYou can configure the browser viewport size, theme, user agent, geolocation, permissions, and more. Capture either just the viewport or the full page scroll.\n\nWhen width and height are specified, the image is resized accordingly. If both dimensions are 0, the API provides an image at original size. If dimensions are not specified, the default viewport size is 1280x720px.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -7574,7 +7770,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -7612,8 +7807,8 @@ "required": false, "schema": { "type": "object", - "x-example": "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}", - "default": {} + "default": [], + "x-example": "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}" }, "in": "query" }, @@ -7665,6 +7860,10 @@ "dark" ], "x-enum-name": "BrowserTheme", + "x-enum-keys": [ + "light", + "dark" + ], "default": "light" }, "in": "query" @@ -8130,7 +8329,428 @@ "pacific\/wallis", "utc" ], - "x-enum-name": "Timezone" + "x-enum-name": "Timezone", + "x-enum-keys": [ + "africa\/abidjan", + "africa\/accra", + "africa\/addis_ababa", + "africa\/algiers", + "africa\/asmara", + "africa\/bamako", + "africa\/bangui", + "africa\/banjul", + "africa\/bissau", + "africa\/blantyre", + "africa\/brazzaville", + "africa\/bujumbura", + "africa\/cairo", + "africa\/casablanca", + "africa\/ceuta", + "africa\/conakry", + "africa\/dakar", + "africa\/dar_es_salaam", + "africa\/djibouti", + "africa\/douala", + "africa\/el_aaiun", + "africa\/freetown", + "africa\/gaborone", + "africa\/harare", + "africa\/johannesburg", + "africa\/juba", + "africa\/kampala", + "africa\/khartoum", + "africa\/kigali", + "africa\/kinshasa", + "africa\/lagos", + "africa\/libreville", + "africa\/lome", + "africa\/luanda", + "africa\/lubumbashi", + "africa\/lusaka", + "africa\/malabo", + "africa\/maputo", + "africa\/maseru", + "africa\/mbabane", + "africa\/mogadishu", + "africa\/monrovia", + "africa\/nairobi", + "africa\/ndjamena", + "africa\/niamey", + "africa\/nouakchott", + "africa\/ouagadougou", + "africa\/porto-novo", + "africa\/sao_tome", + "africa\/tripoli", + "africa\/tunis", + "africa\/windhoek", + "america\/adak", + "america\/anchorage", + "america\/anguilla", + "america\/antigua", + "america\/araguaina", + "america\/argentina\/buenos_aires", + "america\/argentina\/catamarca", + "america\/argentina\/cordoba", + "america\/argentina\/jujuy", + "america\/argentina\/la_rioja", + "america\/argentina\/mendoza", + "america\/argentina\/rio_gallegos", + "america\/argentina\/salta", + "america\/argentina\/san_juan", + "america\/argentina\/san_luis", + "america\/argentina\/tucuman", + "america\/argentina\/ushuaia", + "america\/aruba", + "america\/asuncion", + "america\/atikokan", + "america\/bahia", + "america\/bahia_banderas", + "america\/barbados", + "america\/belem", + "america\/belize", + "america\/blanc-sablon", + "america\/boa_vista", + "america\/bogota", + "america\/boise", + "america\/cambridge_bay", + "america\/campo_grande", + "america\/cancun", + "america\/caracas", + "america\/cayenne", + "america\/cayman", + "america\/chicago", + "america\/chihuahua", + "america\/ciudad_juarez", + "america\/costa_rica", + "america\/coyhaique", + "america\/creston", + "america\/cuiaba", + "america\/curacao", + "america\/danmarkshavn", + "america\/dawson", + "america\/dawson_creek", + "america\/denver", + "america\/detroit", + "america\/dominica", + "america\/edmonton", + "america\/eirunepe", + "america\/el_salvador", + "america\/fort_nelson", + "america\/fortaleza", + "america\/glace_bay", + "america\/goose_bay", + "america\/grand_turk", + "america\/grenada", + "america\/guadeloupe", + "america\/guatemala", + "america\/guayaquil", + "america\/guyana", + "america\/halifax", + "america\/havana", + "america\/hermosillo", + "america\/indiana\/indianapolis", + "america\/indiana\/knox", + "america\/indiana\/marengo", + "america\/indiana\/petersburg", + "america\/indiana\/tell_city", + "america\/indiana\/vevay", + "america\/indiana\/vincennes", + "america\/indiana\/winamac", + "america\/inuvik", + "america\/iqaluit", + "america\/jamaica", + "america\/juneau", + "america\/kentucky\/louisville", + "america\/kentucky\/monticello", + "america\/kralendijk", + "america\/la_paz", + "america\/lima", + "america\/los_angeles", + "america\/lower_princes", + "america\/maceio", + "america\/managua", + "america\/manaus", + "america\/marigot", + "america\/martinique", + "america\/matamoros", + "america\/mazatlan", + "america\/menominee", + "america\/merida", + "america\/metlakatla", + "america\/mexico_city", + "america\/miquelon", + "america\/moncton", + "america\/monterrey", + "america\/montevideo", + "america\/montserrat", + "america\/nassau", + "america\/new_york", + "america\/nome", + "america\/noronha", + "america\/north_dakota\/beulah", + "america\/north_dakota\/center", + "america\/north_dakota\/new_salem", + "america\/nuuk", + "america\/ojinaga", + "america\/panama", + "america\/paramaribo", + "america\/phoenix", + "america\/port-au-prince", + "america\/port_of_spain", + "america\/porto_velho", + "america\/puerto_rico", + "america\/punta_arenas", + "america\/rankin_inlet", + "america\/recife", + "america\/regina", + "america\/resolute", + "america\/rio_branco", + "america\/santarem", + "america\/santiago", + "america\/santo_domingo", + "america\/sao_paulo", + "america\/scoresbysund", + "america\/sitka", + "america\/st_barthelemy", + "america\/st_johns", + "america\/st_kitts", + "america\/st_lucia", + "america\/st_thomas", + "america\/st_vincent", + "america\/swift_current", + "america\/tegucigalpa", + "america\/thule", + "america\/tijuana", + "america\/toronto", + "america\/tortola", + "america\/vancouver", + "america\/whitehorse", + "america\/winnipeg", + "america\/yakutat", + "antarctica\/casey", + "antarctica\/davis", + "antarctica\/dumontdurville", + "antarctica\/macquarie", + "antarctica\/mawson", + "antarctica\/mcmurdo", + "antarctica\/palmer", + "antarctica\/rothera", + "antarctica\/syowa", + "antarctica\/troll", + "antarctica\/vostok", + "arctic\/longyearbyen", + "asia\/aden", + "asia\/almaty", + "asia\/amman", + "asia\/anadyr", + "asia\/aqtau", + "asia\/aqtobe", + "asia\/ashgabat", + "asia\/atyrau", + "asia\/baghdad", + "asia\/bahrain", + "asia\/baku", + "asia\/bangkok", + "asia\/barnaul", + "asia\/beirut", + "asia\/bishkek", + "asia\/brunei", + "asia\/chita", + "asia\/colombo", + "asia\/damascus", + "asia\/dhaka", + "asia\/dili", + "asia\/dubai", + "asia\/dushanbe", + "asia\/famagusta", + "asia\/gaza", + "asia\/hebron", + "asia\/ho_chi_minh", + "asia\/hong_kong", + "asia\/hovd", + "asia\/irkutsk", + "asia\/jakarta", + "asia\/jayapura", + "asia\/jerusalem", + "asia\/kabul", + "asia\/kamchatka", + "asia\/karachi", + "asia\/kathmandu", + "asia\/khandyga", + "asia\/kolkata", + "asia\/krasnoyarsk", + "asia\/kuala_lumpur", + "asia\/kuching", + "asia\/kuwait", + "asia\/macau", + "asia\/magadan", + "asia\/makassar", + "asia\/manila", + "asia\/muscat", + "asia\/nicosia", + "asia\/novokuznetsk", + "asia\/novosibirsk", + "asia\/omsk", + "asia\/oral", + "asia\/phnom_penh", + "asia\/pontianak", + "asia\/pyongyang", + "asia\/qatar", + "asia\/qostanay", + "asia\/qyzylorda", + "asia\/riyadh", + "asia\/sakhalin", + "asia\/samarkand", + "asia\/seoul", + "asia\/shanghai", + "asia\/singapore", + "asia\/srednekolymsk", + "asia\/taipei", + "asia\/tashkent", + "asia\/tbilisi", + "asia\/tehran", + "asia\/thimphu", + "asia\/tokyo", + "asia\/tomsk", + "asia\/ulaanbaatar", + "asia\/urumqi", + "asia\/ust-nera", + "asia\/vientiane", + "asia\/vladivostok", + "asia\/yakutsk", + "asia\/yangon", + "asia\/yekaterinburg", + "asia\/yerevan", + "atlantic\/azores", + "atlantic\/bermuda", + "atlantic\/canary", + "atlantic\/cape_verde", + "atlantic\/faroe", + "atlantic\/madeira", + "atlantic\/reykjavik", + "atlantic\/south_georgia", + "atlantic\/st_helena", + "atlantic\/stanley", + "australia\/adelaide", + "australia\/brisbane", + "australia\/broken_hill", + "australia\/darwin", + "australia\/eucla", + "australia\/hobart", + "australia\/lindeman", + "australia\/lord_howe", + "australia\/melbourne", + "australia\/perth", + "australia\/sydney", + "europe\/amsterdam", + "europe\/andorra", + "europe\/astrakhan", + "europe\/athens", + "europe\/belgrade", + "europe\/berlin", + "europe\/bratislava", + "europe\/brussels", + "europe\/bucharest", + "europe\/budapest", + "europe\/busingen", + "europe\/chisinau", + "europe\/copenhagen", + "europe\/dublin", + "europe\/gibraltar", + "europe\/guernsey", + "europe\/helsinki", + "europe\/isle_of_man", + "europe\/istanbul", + "europe\/jersey", + "europe\/kaliningrad", + "europe\/kirov", + "europe\/kyiv", + "europe\/lisbon", + "europe\/ljubljana", + "europe\/london", + "europe\/luxembourg", + "europe\/madrid", + "europe\/malta", + "europe\/mariehamn", + "europe\/minsk", + "europe\/monaco", + "europe\/moscow", + "europe\/oslo", + "europe\/paris", + "europe\/podgorica", + "europe\/prague", + "europe\/riga", + "europe\/rome", + "europe\/samara", + "europe\/san_marino", + "europe\/sarajevo", + "europe\/saratov", + "europe\/simferopol", + "europe\/skopje", + "europe\/sofia", + "europe\/stockholm", + "europe\/tallinn", + "europe\/tirane", + "europe\/ulyanovsk", + "europe\/vaduz", + "europe\/vatican", + "europe\/vienna", + "europe\/vilnius", + "europe\/volgograd", + "europe\/warsaw", + "europe\/zagreb", + "europe\/zurich", + "indian\/antananarivo", + "indian\/chagos", + "indian\/christmas", + "indian\/cocos", + "indian\/comoro", + "indian\/kerguelen", + "indian\/mahe", + "indian\/maldives", + "indian\/mauritius", + "indian\/mayotte", + "indian\/reunion", + "pacific\/apia", + "pacific\/auckland", + "pacific\/bougainville", + "pacific\/chatham", + "pacific\/chuuk", + "pacific\/easter", + "pacific\/efate", + "pacific\/fakaofo", + "pacific\/fiji", + "pacific\/funafuti", + "pacific\/galapagos", + "pacific\/gambier", + "pacific\/guadalcanal", + "pacific\/guam", + "pacific\/honolulu", + "pacific\/kanton", + "pacific\/kiritimati", + "pacific\/kosrae", + "pacific\/kwajalein", + "pacific\/majuro", + "pacific\/marquesas", + "pacific\/midway", + "pacific\/nauru", + "pacific\/niue", + "pacific\/norfolk", + "pacific\/noumea", + "pacific\/pago_pago", + "pacific\/palau", + "pacific\/pitcairn", + "pacific\/pohnpei", + "pacific\/port_moresby", + "pacific\/rarotonga", + "pacific\/saipan", + "pacific\/tahiti", + "pacific\/tarawa", + "pacific\/tongatapu", + "pacific\/wake", + "pacific\/wallis", + "utc" + ] }, "in": "query" }, @@ -8211,7 +8831,29 @@ "web-share", "xr-spatial-tracking" ], - "x-enum-name": "BrowserPermission" + "x-enum-name": "BrowserPermission", + "x-enum-keys": [ + "geolocation", + "camera", + "microphone", + "notifications", + "midi", + "push", + "clipboard-read", + "clipboard-write", + "payment-handler", + "usb", + "bluetooth", + "accelerometer", + "gyroscope", + "magnetometer", + "ambient-light-sensor", + "background-sync", + "persistent-storage", + "screen-wake-lock", + "web-share", + "xr-spatial-tracking" + ] }, "x-example": "[\"geolocation\",\"notifications\"]", "default": [] @@ -8282,7 +8924,16 @@ "avif", "gif" ], - "x-enum-name": "ImageFormat" + "x-enum-name": "ImageFormat", + "x-enum-keys": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ] }, "in": "query" } @@ -8421,7 +9072,16 @@ "functions", "storage" ], - "x-enum-name": "BackupServices" + "x-enum-name": "BackupServices", + "x-enum-keys": [ + "databases", + "tablesdb", + "documentsdb", + "vectorsdb", + "dedicatedDatabases", + "functions", + "storage" + ] } }, "resourceId": { @@ -8531,6 +9191,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/backups\/delete-archive.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -8710,7 +9373,16 @@ "functions", "storage" ], - "x-enum-name": "BackupServices" + "x-enum-name": "BackupServices", + "x-enum-keys": [ + "databases", + "tablesdb", + "documentsdb", + "vectorsdb", + "dedicatedDatabases", + "functions", + "storage" + ] } }, "resourceId": { @@ -8944,6 +9616,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/backups\/delete-policy.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -9045,7 +9720,16 @@ "functions", "storage" ], - "x-enum-name": "BackupServices" + "x-enum-name": "BackupServices", + "x-enum-keys": [ + "databases", + "tablesdb", + "documentsdb", + "vectorsdb", + "dedicatedDatabases", + "functions", + "storage" + ] } }, "newResourceId": { @@ -9922,6 +10606,9 @@ ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -10098,7 +10785,7 @@ "tags": [ "compute" ], - "description": " List scheduled backup policies for a dedicated database.", + "description": "List scheduled backup policies for a dedicated database.", "responses": { "200": { "description": "Backup policy list", @@ -10168,7 +10855,7 @@ "tags": [ "compute" ], - "description": " Create a scheduled backup policy for a dedicated database.", + "description": "Create a scheduled backup policy for a dedicated database.", "responses": { "201": { "description": "backup", @@ -10483,6 +11170,9 @@ ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -10898,6 +11588,9 @@ ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -11118,6 +11811,7 @@ "bindings": { "type": "object", "description": "Optional bound parameters. Pass either a positional list or a name => value map matching the placeholder style used in the SQL.", + "default": {}, "x-example": "{}", "x-nullable": true }, @@ -12738,6 +13432,10 @@ "imagine" ], "x-enum-name": "Platform", + "x-enum-keys": [ + "appwrite", + "imagine" + ], "default": "appwrite" }, "in": "query" @@ -13032,7 +13730,10 @@ "enum": [ "rules" ], - "x-enum-name": "ConsoleResourceType" + "x-enum-name": "ConsoleResourceType", + "x-enum-keys": [ + "rules" + ] }, "in": "query" } @@ -13746,7 +14447,16 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "ProjectEmailTemplateId" + "x-enum-name": "ProjectEmailTemplateId", + "x-enum-keys": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ] }, "in": "path" }, @@ -13890,7 +14600,140 @@ "zh-tw", "zu" ], - "x-enum-name": "ProjectEmailTemplateLocale" + "x-enum-name": "ProjectEmailTemplateLocale", + "x-enum-keys": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ] }, "in": "query" } @@ -14216,8 +15059,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -14283,8 +15125,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -14355,8 +15196,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -14419,8 +15259,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -14499,8 +15338,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -14565,8 +15403,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -17656,11 +18493,11 @@ "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "array", + "items": { + "type": "number", + "format": "double" + } }, "x-nullable": true } @@ -17774,11 +18611,11 @@ "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "array", + "items": { + "type": "number", + "format": "double" + } }, "x-nullable": true }, @@ -18349,11 +19186,8 @@ "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.", "x-example": "[1, 2]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "number", + "format": "double" }, "x-nullable": true } @@ -18467,11 +19301,8 @@ "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.", "x-example": "[1, 2]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "number", + "format": "double" }, "x-nullable": true }, @@ -18586,11 +19417,14 @@ "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "items": { - "oneOf": [ - { - "type": "array" + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - ] + } }, "x-nullable": true } @@ -18704,11 +19538,14 @@ "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "items": { - "oneOf": [ - { - "type": "array" + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - ] + } }, "x-nullable": true }, @@ -18823,7 +19660,13 @@ "manyToMany", "oneToMany" ], - "x-enum-name": "RelationshipType" + "x-enum-name": "RelationshipType", + "x-enum-keys": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ] }, "twoWay": { "type": "boolean", @@ -18853,7 +19696,12 @@ "restrict", "setNull" ], - "x-enum-name": "RelationMutate" + "x-enum-name": "RelationMutate", + "x-enum-keys": [ + "cascade", + "restrict", + "setNull" + ] } }, "required": [ @@ -18964,7 +19812,12 @@ "restrict", "setNull" ], - "x-enum-name": "RelationMutate" + "x-enum-name": "RelationMutate", + "x-enum-keys": [ + "cascade", + "restrict", + "setNull" + ] }, "newKey": { "type": "string", @@ -20208,7 +21061,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -20332,7 +21184,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -20463,7 +21314,7 @@ "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -20714,7 +21565,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "queries": { @@ -20809,34 +21660,31 @@ "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { @@ -20873,7 +21721,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -20984,7 +21831,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -21086,7 +21932,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -21143,7 +21989,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -21206,7 +22051,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "permissions": { @@ -21256,7 +22101,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -21308,25 +22152,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs": { @@ -21460,8 +22297,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -21590,8 +22426,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -21879,7 +22714,13 @@ "unique", "spatial" ], - "x-enum-name": "DatabasesIndexType" + "x-enum-name": "DatabasesIndexType", + "x-enum-keys": [ + "key", + "fulltext", + "unique", + "spatial" + ] }, "attributes": { "type": "array", @@ -21900,7 +22741,11 @@ "asc", "desc" ], - "x-enum-name": "OrderBy" + "x-enum-name": "OrderBy", + "x-enum-keys": [ + "asc", + "desc" + ] } }, "lengths": { @@ -22692,8 +23537,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -22759,8 +23603,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -22831,8 +23674,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -22895,8 +23737,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -22975,8 +23816,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -23810,7 +24650,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -23930,7 +24769,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -24047,7 +24885,7 @@ "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -24265,108 +25103,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": {}, - "x-example": "{}" - }, - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete documents", - "operationId": "documentsDBDeleteDocuments", - "tags": [ - "documentsDB" - ], - "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", - "responses": { - "200": { - "description": "Documents List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/documentList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteDocuments", - "group": "documents", - "cookies": false, - "type": "", - "demo": "documentsdb\/delete-documents.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-documents.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -24381,6 +25118,12 @@ "schema": { "type": "object", "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": [], + "x-example": "{}" + }, "queries": { "type": "array", "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.", @@ -24400,6 +25143,99 @@ } } } + }, + "delete": { + "summary": "Delete documents", + "operationId": "documentsDBDeleteDocuments", + "tags": [ + "documentsDB" + ], + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "responses": { + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocuments", + "group": "documents", + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + } + ] } }, "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { @@ -24436,7 +25272,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -24543,7 +25378,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -24634,7 +25468,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -24689,7 +25523,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -24748,7 +25581,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -24796,7 +25629,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -24844,24 +25676,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } + ] } }, "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { @@ -24898,8 +25724,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -25022,8 +25847,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -25296,7 +26120,12 @@ "fulltext", "unique" ], - "x-enum-name": "DocumentsDBIndexType" + "x-enum-name": "DocumentsDBIndexType", + "x-enum-keys": [ + "key", + "fulltext", + "unique" + ] }, "attributes": { "type": "array", @@ -25317,7 +26146,11 @@ "asc", "desc" ], - "x-enum-name": "OrderBy" + "x-enum-name": "OrderBy", + "x-enum-keys": [ + "asc", + "desc" + ] } }, "lengths": { @@ -25917,6 +26750,12 @@ "trade" ], "x-enum-name": "DomainRegistrationType", + "x-enum-keys": [ + "new", + "transfer", + "renewal", + "trade" + ], "default": "new" }, "in": "query" @@ -26227,7 +27066,11 @@ "premium", "suggestion" ], - "x-enum-name": "DomainSuggestionType" + "x-enum-name": "DomainSuggestionType", + "x-enum-keys": [ + "premium", + "suggestion" + ] }, "in": "query" }, @@ -26580,6 +27423,9 @@ ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -29700,6 +30546,9 @@ ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -30255,7 +31104,103 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "Runtime" + "x-enum-name": "Runtime", + "x-enum-keys": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dart-3.12", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41", + "flutter-3.44" + ] }, "execute": { "type": "array", @@ -30418,7 +31363,106 @@ "apps.write", "usage.read" ], - "x-enum-name": "ProjectKeyScopes" + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "rules.read", + "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "dedicatedDatabases.execute", + "domains.read", + "domains.write", + "events.read", + "apps.read", + "apps.write", + "usage.read" + ] } }, "installationId": { @@ -30748,7 +31792,103 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "Runtime" + "x-enum-name": "Runtime", + "x-enum-keys": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dart-3.12", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41", + "flutter-3.44" + ] }, "default": [] }, @@ -30771,7 +31911,16 @@ "dev-tools", "auth" ], - "x-enum-name": "FunctionTemplateUseCase" + "x-enum-name": "FunctionTemplateUseCase", + "x-enum-keys": [ + "starter", + "databases", + "ai", + "messaging", + "utilities", + "dev-tools", + "auth" + ] }, "default": [] }, @@ -31174,7 +32323,103 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "Runtime" + "x-enum-name": "Runtime", + "x-enum-keys": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dart-3.12", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41", + "flutter-3.44" + ] }, "execute": { "type": "array", @@ -31337,7 +32582,106 @@ "apps.write", "usage.read" ], - "x-enum-name": "ProjectKeyScopes" + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "rules.read", + "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "dedicatedDatabases.execute", + "domains.read", + "domains.write", + "events.read", + "apps.read", + "apps.write", + "usage.read" + ] } }, "installationId": { @@ -31917,7 +33261,12 @@ "branch", "tag" ], - "x-enum-name": "TemplateReferenceType" + "x-enum-name": "TemplateReferenceType", + "x-enum-keys": [ + "commit", + "branch", + "tag" + ] }, "reference": { "type": "string", @@ -32017,7 +33366,11 @@ "branch", "commit" ], - "x-enum-name": "VCSReferenceType" + "x-enum-name": "VCSReferenceType", + "x-enum-keys": [ + "branch", + "commit" + ] }, "reference": { "type": "string", @@ -32184,7 +33537,15 @@ "description": "Get 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.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "*\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -32200,7 +33561,6 @@ "scope": "functions.read", "platforms": [ "console", - "server", "server" ], "packaging": false, @@ -32251,6 +33611,10 @@ "output" ], "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [ + "source", + "output" + ], "default": "source" }, "in": "query" @@ -32366,7 +33730,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -32456,7 +33819,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -32523,12 +33885,21 @@ "OPTIONS", "HEAD" ], - "x-enum-name": "ExecutionMethod" + "x-enum-name": "ExecutionMethod", + "x-enum-keys": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ] }, "headers": { "type": "object", "description": "HTTP headers of execution. Defaults to empty.", - "default": {}, + "default": [], "x-example": "{}" }, "scheduledAt": { @@ -32581,7 +33952,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -33217,8 +34587,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -33234,7 +34603,27 @@ "Session": [], "JWT": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "type": "object", + "description": "The query or queries to execute.", + "default": {}, + "x-example": "{}" + } + }, + "required": [ + "query" + ] + } + } + } + } } }, "\/graphql\/mutation": { @@ -33271,8 +34660,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -33288,7 +34676,27 @@ "Session": [], "JWT": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "type": "object", + "description": "The query or queries to execute.", + "default": {}, + "x-example": "{}" + } + }, + "required": [ + "query" + ] + } + } + } + } } }, "\/health": { @@ -34312,7 +35720,22 @@ "v1-messaging", "v1-migrations" ], - "x-enum-name": "HealthQueueName" + "x-enum-name": "HealthQueueName", + "x-enum-keys": [ + "v1-database", + "v1-deletes", + "v1-audits", + "v1-mails", + "v1-functions", + "v1-stats-resources", + "v1-stats-usage", + "v1-webhooks", + "v1-certificates", + "v1-builds", + "v1-screenshots", + "v1-messaging", + "v1-migrations" + ] }, "in": "path" }, @@ -35144,7 +36567,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -35198,7 +36620,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -35252,7 +36673,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -35306,7 +36726,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -35360,7 +36779,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -35414,7 +36832,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -35468,7 +36885,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -35522,7 +36938,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -35605,7 +37020,18 @@ "subscribers", "messages" ], - "x-enum-name": "BlockResourceType" + "x-enum-name": "BlockResourceType", + "x-enum-keys": [ + "projects", + "functions", + "sites", + "databases", + "buckets", + "providers", + "topics", + "subscribers", + "messages" + ] }, "resourceId": { "type": "string", @@ -35672,49 +37098,62 @@ "packaging": false, "public": true }, - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "projectId": { - "type": "string", - "description": "Project ID", - "x-example": "" - }, - "resourceType": { - "type": "string", - "description": "Resource type to unblock", - "x-example": "projects", - "enum": [ - "projects", - "functions", - "sites", - "databases", - "buckets", - "providers", - "topics", - "subscribers", - "messages" - ], - "x-enum-name": "BlockResourceType" - }, - "resourceId": { - "type": "string", - "description": "Optional resource ID (if omitted, all blocks of this type will be removed)", - "default": "", - "x-example": "" - } - }, - "required": [ - "projectId", - "resourceType" - ] - } - } + "parameters": [ + { + "name": "projectId", + "description": "Project ID", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + }, + { + "name": "resourceType", + "description": "Resource type to unblock", + "required": true, + "schema": { + "type": "string", + "x-example": "projects", + "enum": [ + "projects", + "functions", + "sites", + "databases", + "buckets", + "providers", + "topics", + "subscribers", + "messages" + ], + "x-enum-name": "BlockResourceType", + "x-enum-keys": [ + "projects", + "functions", + "sites", + "databases", + "buckets", + "providers", + "topics", + "subscribers", + "messages" + ] + }, + "in": "query" + }, + { + "name": "resourceId", + "description": "Optional resource ID (if omitted, all blocks of this type will be removed)", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } - } + ] } }, "\/manager\/blocks\/{projectId}": { @@ -35778,7 +37217,15 @@ "description": "Clears internal cache.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "application\/json": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -35798,82 +37245,129 @@ "packaging": false, "public": true }, - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "region": { - "type": "string", - "description": "Target region.", - "x-example": "fra", - "enum": [ - "fra", - "nyc", - "syd", - "sfo", - "sgp", - "tor" - ], - "x-enum-name": "Region" - }, - "cache": { - "type": "string", - "description": "Cache target.", - "default": "cache", - "x-example": "cache", - "enum": [ - "cache", - "timelimit", - "locks", - "pubsub", - "queue", - "all" - ], - "x-enum-name": "CacheTarget" - }, - "all": { - "type": "boolean", - "description": "Clear the entire selected cache target.", - "default": false, - "x-example": false - }, - "database": { - "type": "string", - "description": "Database cache scope.", - "default": "console", - "x-example": "console", - "enum": [ - "console", - "project", - "logs" - ], - "x-enum-name": "CacheDatabase" - }, - "projectId": { - "type": "string", - "description": "Project ID for project or logs database cache.", - "default": "", - "x-example": "" - }, - "collectionId": { - "type": "string", - "description": "Collection ID.", - "default": "", - "x-example": "" - }, - "documentId": { - "type": "string", - "description": "Document ID.", - "default": "", - "x-example": "" - } - } - } - } + "parameters": [ + { + "name": "region", + "description": "Target region.", + "required": false, + "schema": { + "type": "string", + "x-example": "fra", + "enum": [ + "fra", + "nyc", + "syd", + "sfo", + "sgp", + "tor" + ], + "x-enum-name": "Region", + "x-enum-keys": [ + "fra", + "nyc", + "syd", + "sfo", + "sgp", + "tor" + ] + }, + "in": "query" + }, + { + "name": "cache", + "description": "Cache target.", + "required": false, + "schema": { + "type": "string", + "x-example": "cache", + "enum": [ + "cache", + "timelimit", + "locks", + "pubsub", + "queue", + "all" + ], + "x-enum-name": "CacheTarget", + "x-enum-keys": [ + "cache", + "timelimit", + "locks", + "pubsub", + "queue", + "all" + ], + "default": "cache" + }, + "in": "query" + }, + { + "name": "all", + "description": "Clear the entire selected cache target.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": false + }, + "in": "query" + }, + { + "name": "database", + "description": "Database cache scope.", + "required": false, + "schema": { + "type": "string", + "x-example": "console", + "enum": [ + "console", + "project", + "logs" + ], + "x-enum-name": "CacheDatabase", + "x-enum-keys": [ + "console", + "project", + "logs" + ], + "default": "console" + }, + "in": "query" + }, + { + "name": "projectId", + "description": "Project ID for project or logs database cache.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } - } + ] } }, "\/manager\/users\/status": { @@ -36458,6 +37952,7 @@ "data": { "type": "object", "description": "Additional key-value pair data for push notification.", + "default": {}, "x-example": "{}", "x-nullable": true }, @@ -36538,7 +38033,11 @@ "normal", "high" ], - "x-enum-name": "MessagePriority" + "x-enum-name": "MessagePriority", + "x-enum-keys": [ + "normal", + "high" + ] } }, "required": [ @@ -36658,6 +38157,7 @@ "data": { "type": "object", "description": "Additional Data for push notification.", + "default": {}, "x-example": "{}", "x-nullable": true }, @@ -36738,6 +38238,10 @@ "high" ], "x-enum-name": "MessagePriority", + "x-enum-keys": [ + "normal", + "high" + ], "x-nullable": true } } @@ -38001,6 +39505,7 @@ "serviceAccountJSON": { "type": "object", "description": "FCM service account JSON.", + "default": {}, "x-example": "{}", "x-nullable": true }, @@ -38164,6 +39669,7 @@ "serviceAccountJSON": { "type": "object", "description": "FCM service account JSON.", + "default": {}, "x-example": "{}", "x-nullable": true } @@ -39542,7 +41048,12 @@ "ssl", "tls" ], - "x-enum-name": "SmtpEncryption" + "x-enum-name": "SmtpEncryption", + "x-enum-keys": [ + "none", + "ssl", + "tls" + ] }, "autoTLS": { "type": "boolean", @@ -39789,7 +41300,12 @@ "ssl", "tls" ], - "x-enum-name": "SmtpEncryption" + "x-enum-name": "SmtpEncryption", + "x-enum-keys": [ + "none", + "ssl", + "tls" + ] }, "autoTLS": { "type": "boolean", @@ -41542,8 +43058,7 @@ "platforms": [ "server", "client", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -41699,8 +43214,7 @@ "platforms": [ "server", "client", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -41925,7 +43439,48 @@ "project-email-template", "rule" ], - "x-enum-name": "AppwriteMigrationResource" + "x-enum-name": "AppwriteMigrationResource", + "x-enum-keys": [ + "user", + "team", + "membership", + "auth-methods", + "policies", + "oauth2-provider", + "database", + "table", + "column", + "index", + "row", + "document", + "attribute", + "collection", + "documentsdb", + "vectorsdb", + "bucket", + "file", + "function", + "deployment", + "environment-variable", + "provider", + "topic", + "subscriber", + "message", + "site", + "site-deployment", + "site-variable", + "platform", + "api-key", + "webhook", + "smtp", + "backup-policy", + "project-variable", + "project-protocols", + "project-labels", + "project-services", + "project-email-template", + "rule" + ] } }, "endpoint": { @@ -41954,7 +43509,12 @@ "skip", "overwrite" ], - "x-enum-name": "OnDuplicate" + "x-enum-name": "OnDuplicate", + "x-enum-keys": [ + "fail", + "skip", + "overwrite" + ] } }, "required": [ @@ -42065,7 +43625,48 @@ "project-email-template", "rule" ], - "x-enum-name": "AppwriteMigrationResource" + "x-enum-name": "AppwriteMigrationResource", + "x-enum-keys": [ + "user", + "team", + "membership", + "auth-methods", + "policies", + "oauth2-provider", + "database", + "table", + "column", + "index", + "row", + "document", + "attribute", + "collection", + "documentsdb", + "vectorsdb", + "bucket", + "file", + "function", + "deployment", + "environment-variable", + "provider", + "topic", + "subscriber", + "message", + "site", + "site-deployment", + "site-variable", + "platform", + "api-key", + "webhook", + "smtp", + "backup-policy", + "project-variable", + "project-protocols", + "project-labels", + "project-services", + "project-email-template", + "rule" + ] } }, "in": "query" @@ -42308,7 +43909,12 @@ "skip", "overwrite" ], - "x-enum-name": "OnDuplicate" + "x-enum-name": "OnDuplicate", + "x-enum-keys": [ + "fail", + "skip", + "overwrite" + ] } }, "required": [ @@ -42392,7 +43998,19 @@ "bucket", "file" ], - "x-enum-name": "FirebaseMigrationResource" + "x-enum-name": "FirebaseMigrationResource", + "x-enum-keys": [ + "user", + "database", + "table", + "column", + "row", + "document", + "attribute", + "collection", + "bucket", + "file" + ] } }, "serviceAccount": { @@ -42478,7 +44096,19 @@ "bucket", "file" ], - "x-enum-name": "FirebaseMigrationResource" + "x-enum-name": "FirebaseMigrationResource", + "x-enum-keys": [ + "user", + "database", + "table", + "column", + "row", + "document", + "attribute", + "collection", + "bucket", + "file" + ] } }, "in": "query" @@ -42676,7 +44306,12 @@ "skip", "overwrite" ], - "x-enum-name": "OnDuplicate" + "x-enum-name": "OnDuplicate", + "x-enum-keys": [ + "fail", + "skip", + "overwrite" + ] } }, "required": [ @@ -42761,7 +44396,20 @@ "bucket", "file" ], - "x-enum-name": "NHostMigrationResource" + "x-enum-name": "NHostMigrationResource", + "x-enum-keys": [ + "user", + "database", + "table", + "column", + "index", + "row", + "document", + "attribute", + "collection", + "bucket", + "file" + ] } }, "subdomain": { @@ -42886,7 +44534,20 @@ "bucket", "file" ], - "x-enum-name": "NHostMigrationResource" + "x-enum-name": "NHostMigrationResource", + "x-enum-keys": [ + "user", + "database", + "table", + "column", + "index", + "row", + "document", + "attribute", + "collection", + "bucket", + "file" + ] } }, "in": "query" @@ -43037,7 +44698,20 @@ "bucket", "file" ], - "x-enum-name": "SupabaseMigrationResource" + "x-enum-name": "SupabaseMigrationResource", + "x-enum-keys": [ + "user", + "database", + "table", + "column", + "index", + "row", + "document", + "attribute", + "collection", + "bucket", + "file" + ] } }, "endpoint": { @@ -43157,7 +44831,20 @@ "bucket", "file" ], - "x-enum-name": "SupabaseMigrationResource" + "x-enum-name": "SupabaseMigrationResource", + "x-enum-keys": [ + "user", + "database", + "table", + "column", + "index", + "row", + "document", + "attribute", + "collection", + "bucket", + "file" + ] } }, "in": "query" @@ -43554,7 +45241,19 @@ "keys.read", "keys.write" ], - "x-enum-name": "OrganizationKeyScopes" + "x-enum-name": "OrganizationKeyScopes", + "x-enum-keys": [ + "projects.read", + "projects.write", + "devKeys.read", + "devKeys.write", + "organization.keys.read", + "organization.keys.write", + "domains.read", + "domains.write", + "keys.read", + "keys.write" + ] } }, "expire": { @@ -43723,7 +45422,19 @@ "keys.read", "keys.write" ], - "x-enum-name": "OrganizationKeyScopes" + "x-enum-name": "OrganizationKeyScopes", + "x-enum-keys": [ + "projects.read", + "projects.write", + "devKeys.read", + "devKeys.write", + "organization.keys.read", + "organization.keys.write", + "domains.read", + "domains.write", + "keys.read", + "keys.write" + ] } }, "expire": { @@ -43955,7 +45666,15 @@ "sgp", "tor" ], - "x-enum-name": "Region" + "x-enum-name": "Region", + "x-enum-keys": [ + "fra", + "nyc", + "syd", + "sfo", + "sgp", + "tor" + ] } }, "required": [ @@ -44358,7 +46077,11 @@ "appwrite", "imagine" ], - "x-enum-name": "Platform" + "x-enum-name": "Platform", + "x-enum-keys": [ + "appwrite", + "imagine" + ] } }, "required": [ @@ -44459,7 +46182,11 @@ "appwrite", "imagine" ], - "x-enum-name": "Platform" + "x-enum-name": "Platform", + "x-enum-keys": [ + "appwrite", + "imagine" + ] } }, "required": [ @@ -44501,6 +46228,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -44742,6 +46472,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/delete-addon.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -44913,7 +46646,11 @@ "baa", "backup_recovery" ], - "x-enum-name": "Addon" + "x-enum-name": "Addon", + "x-enum-keys": [ + "baa", + "backup_recovery" + ] }, "in": "path" } @@ -45193,6 +46930,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/organizations\/delete-billing-address.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -47517,8 +49257,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -47681,8 +49420,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -47834,7 +49572,7 @@ "metadata": { "type": "object", "description": "Presence metadata object.", - "default": {}, + "default": [], "x-example": "{}" } }, @@ -47960,6 +49698,7 @@ "metadata": { "type": "object", "description": "Presence metadata object.", + "default": {}, "x-example": "{}" }, "permissions": { @@ -48008,8 +49747,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -48193,7 +49931,16 @@ "jwt", "phone" ], - "x-enum-name": "ProjectAuthMethodId" + "x-enum-name": "ProjectAuthMethodId", + "x-enum-keys": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ] }, "in": "path" } @@ -48463,7 +50210,106 @@ "apps.write", "usage.read" ], - "x-enum-name": "ProjectKeyScopes" + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "rules.read", + "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "dedicatedDatabases.execute", + "domains.read", + "domains.write", + "events.read", + "apps.read", + "apps.write", + "usage.read" + ] } }, "expire": { @@ -48643,7 +50489,106 @@ "apps.write", "usage.read" ], - "x-enum-name": "ProjectKeyScopes" + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "rules.read", + "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "dedicatedDatabases.execute", + "domains.read", + "domains.write", + "events.read", + "apps.read", + "apps.write", + "usage.read" + ] } }, "duration": { @@ -48897,7 +50842,106 @@ "apps.write", "usage.read" ], - "x-enum-name": "ProjectKeyScopes" + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "rules.read", + "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "dedicatedDatabases.execute", + "domains.read", + "domains.write", + "events.read", + "apps.read", + "apps.write", + "usage.read" + ] } }, "expire": { @@ -51129,7 +53173,12 @@ "consent", "select_account" ], - "x-enum-name": "ProjectOAuth2GooglePrompt" + "x-enum-name": "ProjectOAuth2GooglePrompt", + "x-enum-keys": [ + "none", + "consent", + "select_account" + ] }, "x-nullable": true }, @@ -53266,7 +55315,52 @@ "zoho", "zoom" ], - "x-enum-name": "ProjectOAuthProviderId" + "x-enum-name": "ProjectOAuthProviderId", + "x-enum-keys": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom" + ] }, "in": "path" } @@ -55511,7 +57605,22 @@ "deny-disposable-email", "deny-free-email" ], - "x-enum-name": "ProjectPolicyId" + "x-enum-name": "ProjectPolicyId", + "x-enum-keys": [ + "password-dictionary", + "password-history", + "password-strength", + "password-personal-data", + "session-alert", + "session-duration", + "session-invalidation", + "session-limit", + "user-limit", + "membership-privacy", + "deny-aliased-email", + "deny-disposable-email", + "deny-free-email" + ] }, "in": "path" } @@ -55578,7 +57687,12 @@ "graphql", "websocket" ], - "x-enum-name": "ProjectProtocolId" + "x-enum-name": "ProjectProtocolId", + "x-enum-keys": [ + "rest", + "graphql", + "websocket" + ] }, "in": "path" } @@ -55679,7 +57793,27 @@ "messaging", "advisor" ], - "x-enum-name": "ProjectServiceId" + "x-enum-name": "ProjectServiceId", + "x-enum-keys": [ + "account", + "avatars", + "databases", + "tablesdb", + "locale", + "health", + "project", + "storage", + "teams", + "users", + "vcs", + "sites", + "functions", + "proxy", + "graphql", + "migrations", + "messaging", + "advisor" + ] }, "in": "path" } @@ -55819,6 +57953,10 @@ "ssl" ], "x-enum-name": "ProjectSMTPSecure", + "x-enum-keys": [ + "tls", + "ssl" + ], "x-nullable": true }, "enabled": { @@ -56037,7 +58175,16 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "ProjectEmailTemplateId" + "x-enum-name": "ProjectEmailTemplateId", + "x-enum-keys": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ] }, "locale": { "type": "string", @@ -56176,7 +58323,140 @@ "zh-tw", "zu" ], - "x-enum-name": "ProjectEmailTemplateLocale" + "x-enum-name": "ProjectEmailTemplateLocale", + "x-enum-keys": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ] }, "subject": { "type": "string", @@ -56290,7 +58570,16 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "ProjectEmailTemplateId" + "x-enum-name": "ProjectEmailTemplateId", + "x-enum-keys": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ] }, "in": "path" }, @@ -56434,7 +58723,140 @@ "zh-tw", "zu" ], - "x-enum-name": "ProjectEmailTemplateLocale" + "x-enum-name": "ProjectEmailTemplateLocale", + "x-enum-keys": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ] }, "in": "query" } @@ -56926,6 +59348,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-console-access.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -57482,7 +59907,13 @@ "message", "backup" ], - "x-enum-name": "ScheduleResourceType" + "x-enum-name": "ScheduleResourceType", + "x-enum-keys": [ + "function", + "execution", + "message", + "backup" + ] }, "resourceId": { "type": "string", @@ -57503,6 +59934,7 @@ "data": { "type": "object", "description": "Schedule data as a JSON string. Used to store resource-specific context needed for execution.", + "default": {}, "x-example": "{}" } }, @@ -57617,6 +60049,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/projects\/update-status.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -57651,7 +60086,10 @@ "enum": [ "active" ], - "x-enum-name": "Status" + "x-enum-name": "Status", + "x-enum-keys": [ + "active" + ] } }, "required": [ @@ -58854,7 +61292,24 @@ "vite", "other" ], - "x-enum-name": "Framework" + "x-enum-name": "Framework", + "x-enum-keys": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ] }, "enabled": { "type": "boolean", @@ -58999,7 +61454,103 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "BuildRuntime" + "x-enum-name": "BuildRuntime", + "x-enum-keys": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dart-3.12", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41", + "flutter-3.44" + ] }, "adapter": { "type": "string", @@ -59009,7 +61560,11 @@ "static", "ssr" ], - "x-enum-name": "Adapter" + "x-enum-name": "Adapter", + "x-enum-keys": [ + "static", + "ssr" + ] }, "installationId": { "type": "string", @@ -59266,7 +61821,24 @@ "vite", "other" ], - "x-enum-name": "Framework" + "x-enum-name": "Framework", + "x-enum-keys": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ] }, "default": [] }, @@ -59291,7 +61863,18 @@ "forms", "dashboard" ], - "x-enum-name": "SiteTemplateUseCase" + "x-enum-name": "SiteTemplateUseCase", + "x-enum-keys": [ + "portfolio", + "starter", + "events", + "ecommerce", + "documentation", + "blog", + "ai", + "forms", + "dashboard" + ] }, "default": [] }, @@ -59604,7 +62187,24 @@ "vite", "other" ], - "x-enum-name": "Framework" + "x-enum-name": "Framework", + "x-enum-keys": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ] }, "enabled": { "type": "boolean", @@ -59749,7 +62349,103 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "BuildRuntime" + "x-enum-name": "BuildRuntime", + "x-enum-keys": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dart-3.12", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41", + "flutter-3.44" + ] }, "adapter": { "type": "string", @@ -59759,7 +62455,11 @@ "static", "ssr" ], - "x-enum-name": "Adapter" + "x-enum-name": "Adapter", + "x-enum-keys": [ + "static", + "ssr" + ] }, "fallbackFile": { "type": "string", @@ -60345,7 +63045,12 @@ "commit", "tag" ], - "x-enum-name": "TemplateReferenceType" + "x-enum-name": "TemplateReferenceType", + "x-enum-keys": [ + "branch", + "commit", + "tag" + ] }, "reference": { "type": "string", @@ -60446,7 +63151,12 @@ "commit", "tag" ], - "x-enum-name": "VCSReferenceType" + "x-enum-name": "VCSReferenceType", + "x-enum-keys": [ + "branch", + "commit", + "tag" + ] }, "reference": { "type": "string", @@ -60613,7 +63323,15 @@ "description": "Get a site 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.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "*\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -60629,7 +63347,6 @@ "scope": "sites.read", "platforms": [ "console", - "server", "server" ], "packaging": false, @@ -60680,6 +63397,10 @@ "output" ], "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [ + "source", + "output" + ], "default": "source" }, "in": "query" @@ -60942,6 +63663,9 @@ ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -61671,7 +64395,12 @@ "gzip", "zstd" ], - "x-enum-name": "Compression" + "x-enum-name": "Compression", + "x-enum-keys": [ + "none", + "gzip", + "zstd" + ] }, "encryption": { "type": "boolean", @@ -61880,7 +64609,12 @@ "gzip", "zstd" ], - "x-enum-name": "Compression" + "x-enum-name": "Compression", + "x-enum-keys": [ + "none", + "gzip", + "zstd" + ] }, "encryption": { "type": "boolean", @@ -61997,7 +64731,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -62096,7 +64829,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -62201,7 +64933,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -62275,7 +65006,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -62367,7 +65097,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -62419,7 +65148,15 @@ "description": "Get a file 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.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "*\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -62436,7 +65173,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -62501,7 +65237,15 @@ "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -62518,7 +65262,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -62602,6 +65345,17 @@ "bottom-right" ], "x-enum-name": "ImageGravity", + "x-enum-keys": [ + "center", + "top-left", + "top", + "top-right", + "left", + "right", + "bottom-left", + "bottom", + "bottom-right" + ], "default": "center" }, "in": "query" @@ -62702,7 +65456,16 @@ "avif", "gif" ], - "x-enum-name": "ImageFormat" + "x-enum-name": "ImageFormat", + "x-enum-keys": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ] }, "in": "query" }, @@ -62730,7 +65493,15 @@ "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "*\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -62747,7 +65518,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -63171,8 +65941,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -63241,8 +66010,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -63316,8 +66084,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -63383,8 +66150,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -63466,8 +66232,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -63535,8 +66300,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -66534,11 +69298,11 @@ "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "array", + "items": { + "type": "number", + "format": "double" + } }, "x-nullable": true } @@ -66653,11 +69417,11 @@ "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "array", + "items": { + "type": "number", + "format": "double" + } }, "x-nullable": true }, @@ -67249,11 +70013,8 @@ "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", "x-example": "[1, 2]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "number", + "format": "double" }, "x-nullable": true } @@ -67368,11 +70129,8 @@ "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", "x-example": "[1, 2]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "number", + "format": "double" }, "x-nullable": true }, @@ -67488,11 +70246,14 @@ "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "items": { - "oneOf": [ - { - "type": "array" + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - ] + } }, "x-nullable": true } @@ -67607,11 +70368,14 @@ "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "items": { - "oneOf": [ - { - "type": "array" + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - ] + } }, "x-nullable": true }, @@ -67727,7 +70491,13 @@ "manyToMany", "oneToMany" ], - "x-enum-name": "RelationshipType" + "x-enum-name": "RelationshipType", + "x-enum-keys": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ] }, "twoWay": { "type": "boolean", @@ -67757,7 +70527,12 @@ "restrict", "setNull" ], - "x-enum-name": "RelationMutate" + "x-enum-name": "RelationMutate", + "x-enum-keys": [ + "cascade", + "restrict", + "setNull" + ] } }, "required": [ @@ -69099,6 +71874,11 @@ "setNull" ], "x-enum-name": "RelationMutate", + "x-enum-keys": [ + "cascade", + "restrict", + "setNull" + ], "x-nullable": true }, "newKey": { @@ -69307,7 +72087,13 @@ "unique", "spatial" ], - "x-enum-name": "TablesDBIndexType" + "x-enum-name": "TablesDBIndexType", + "x-enum-keys": [ + "key", + "fulltext", + "unique", + "spatial" + ] }, "columns": { "type": "array", @@ -69328,7 +72114,11 @@ "asc", "desc" ], - "x-enum-name": "OrderBy" + "x-enum-name": "OrderBy", + "x-enum-keys": [ + "asc", + "desc" + ] } }, "lengths": { @@ -69636,7 +72426,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -69759,7 +72548,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -69878,7 +72666,7 @@ "data": { "type": "object", "description": "Row data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -70123,7 +72911,7 @@ "data": { "type": "object", "description": "Row data as JSON object. Include only column and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "queries": { @@ -70217,34 +73005,31 @@ "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { @@ -70284,7 +73069,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -70394,7 +73178,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -70485,7 +73268,7 @@ "data": { "type": "object", "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "permissions": { @@ -70545,7 +73328,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -70604,7 +73386,7 @@ "data": { "type": "object", "description": "Row data as JSON object. Include only columns and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "permissions": { @@ -70657,7 +73439,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -70705,25 +73486,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": { @@ -70859,8 +73633,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -70988,8 +73761,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -71320,7 +74092,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -71409,7 +74180,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -71502,7 +74272,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -71566,7 +74335,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -71642,7 +74410,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -71792,7 +74559,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -71891,7 +74657,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -72012,7 +74777,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -72086,7 +74850,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -72175,7 +74938,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -72449,6 +75211,7 @@ "prefs": { "type": "object", "description": "Prefs key-value JSON object.", + "default": {}, "x-example": "{}" } }, @@ -74004,7 +76767,20 @@ "sha3-384", "sha3-512" ], - "x-enum-name": "PasswordHash" + "x-enum-name": "PasswordHash", + "x-enum-keys": [ + "sha1", + "sha224", + "sha256", + "sha384", + "sha512\/224", + "sha512\/256", + "sha512", + "sha3-224", + "sha3-256", + "sha3-384", + "sha3-512" + ] }, "name": { "type": "string", @@ -74084,6 +76860,11 @@ "90d" ], "x-enum-name": "UsageRange", + "x-enum-keys": [ + "24h", + "30d", + "90d" + ], "default": "30d" }, "in": "query" @@ -74983,7 +77764,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -75832,6 +78616,7 @@ "prefs": { "type": "object", "description": "Prefs key-value JSON object.", + "default": {}, "x-example": "{}" } }, @@ -76358,7 +79143,12 @@ "sms", "push" ], - "x-enum-name": "MessagingProviderType" + "x-enum-name": "MessagingProviderType", + "x-enum-keys": [ + "email", + "sms", + "push" + ] }, "identifier": { "type": "string", @@ -76963,7 +79753,11 @@ "runtime", "framework" ], - "x-enum-name": "VCSDetectionType" + "x-enum-name": "VCSDetectionType", + "x-enum-keys": [ + "runtime", + "framework" + ] }, "providerRootDirectory": { "type": "string", @@ -77064,7 +79858,11 @@ "runtime", "framework" ], - "x-enum-name": "VCSDetectionType" + "x-enum-name": "VCSDetectionType", + "x-enum-keys": [ + "runtime", + "framework" + ] }, "in": "query" }, @@ -77464,6 +80262,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/update-external-deployments.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [] } @@ -77912,7 +80713,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", "server" ], "packaging": false, @@ -77980,7 +80780,13 @@ "all-minilm", "bge-small" ], - "x-enum-name": "EmbeddingModel" + "x-enum-name": "EmbeddingModel", + "x-enum-keys": [ + "nomic-embed-text", + "embedding-gemma", + "all-minilm", + "bge-small" + ] } }, "required": [ @@ -78026,8 +80832,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -78093,8 +80898,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -78165,8 +80969,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -78229,8 +81032,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -78309,8 +81111,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -78375,8 +81176,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -79218,7 +82018,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -79338,7 +82137,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -79455,7 +82253,7 @@ "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" }, "permissions": { @@ -79691,7 +82489,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{}" }, "queries": { @@ -79781,33 +82579,31 @@ "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } + ] } }, "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { @@ -79844,7 +82640,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -79951,7 +82746,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -80045,7 +82839,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -80100,7 +82894,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -80159,7 +82952,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -80207,7 +83000,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -80255,24 +83047,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } + ] } }, "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { @@ -80462,7 +83248,15 @@ "key", "unique" ], - "x-enum-name": "VectorsDBIndexType" + "x-enum-name": "VectorsDBIndexType", + "x-enum-keys": [ + "hnsw_euclidean", + "hnsw_dot", + "hnsw_cosine", + "object", + "key", + "unique" + ] }, "attributes": { "type": "array", @@ -80483,7 +83277,11 @@ "asc", "desc" ], - "x-enum-name": "OrderBy" + "x-enum-name": "OrderBy", + "x-enum-keys": [ + "asc", + "desc" + ] } }, "lengths": { @@ -81456,44 +84254,6 @@ "additionalProperties": true, "example": [] }, - "error": { - "description": "Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Error message.", - "x-example": "Not found" - }, - "code": { - "type": "string", - "description": "Error code.", - "x-example": "404" - }, - "type": { - "type": "string", - "description": "Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes", - "x-example": "not_found" - }, - "version": { - "type": "string", - "description": "Server version number.", - "x-example": "1.0" - } - }, - "required": [ - "message", - "code", - "type", - "version" - ], - "example": { - "message": "Not found", - "code": "404", - "type": "not_found", - "version": "1.0" - } - }, "rowList": { "description": "Rows List", "type": "object", @@ -84857,6 +87617,10 @@ 0, 0 ], + "items": { + "type": "number", + "format": "double" + }, "nullable": true } }, @@ -84950,6 +87714,13 @@ 1 ] ], + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, "nullable": true } }, @@ -85061,6 +87832,16 @@ ] ] ], + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + }, "nullable": true } }, @@ -87602,6 +90383,10 @@ 0, 0 ], + "items": { + "type": "number", + "format": "double" + }, "nullable": true } }, @@ -87695,6 +90480,13 @@ 1 ] ], + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, "nullable": true } }, @@ -87806,6 +90598,16 @@ ] ] ], + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + }, "nullable": true } }, @@ -88596,11 +91398,11 @@ }, "metadata": { "type": "object", + "additionalProperties": true, "description": "Presence metadata.", "x-example": { "key": "value" - }, - "nullable": true + } } }, "required": [ @@ -88831,43 +91633,45 @@ "type": "object", "description": "Password hashing algorithm configuration.", "x-example": {}, - "items": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/algoArgon2" - }, - { - "$ref": "#\/components\/schemas\/algoScrypt" - }, - { - "$ref": "#\/components\/schemas\/algoScryptModified" - }, - { - "$ref": "#\/components\/schemas\/algoBcrypt" - }, - { - "$ref": "#\/components\/schemas\/algoPhpass" - }, - { - "$ref": "#\/components\/schemas\/algoSha" - }, - { - "$ref": "#\/components\/schemas\/algoMd5" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "argon2": "#\/components\/schemas\/algoArgon2", - "scrypt": "#\/components\/schemas\/algoScrypt", - "scryptMod": "#\/components\/schemas\/algoScryptModified", - "bcrypt": "#\/components\/schemas\/algoBcrypt", - "phpass": "#\/components\/schemas\/algoPhpass", - "sha": "#\/components\/schemas\/algoSha", - "md5": "#\/components\/schemas\/algoMd5" + "allOf": [ + { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/algoArgon2" + }, + { + "$ref": "#\/components\/schemas\/algoScrypt" + }, + { + "$ref": "#\/components\/schemas\/algoScryptModified" + }, + { + "$ref": "#\/components\/schemas\/algoBcrypt" + }, + { + "$ref": "#\/components\/schemas\/algoPhpass" + }, + { + "$ref": "#\/components\/schemas\/algoSha" + }, + { + "$ref": "#\/components\/schemas\/algoMd5" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "argon2": "#\/components\/schemas\/algoArgon2", + "scrypt": "#\/components\/schemas\/algoScrypt", + "scryptMod": "#\/components\/schemas\/algoScryptModified", + "bcrypt": "#\/components\/schemas\/algoBcrypt", + "phpass": "#\/components\/schemas\/algoPhpass", + "sha": "#\/components\/schemas\/algoSha", + "md5": "#\/components\/schemas\/algoMd5" + } } } - }, + ], "nullable": true }, "registration": { @@ -88957,9 +91761,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "$ref": "#\/components\/schemas\/preferences" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/preferences" + } + ] }, "targets": { "type": "array", @@ -90038,9 +92844,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "$ref": "#\/components\/schemas\/preferences" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/preferences" + } + ] } }, "required": [ @@ -92403,9 +95211,11 @@ "type": "object", "description": "Billing limits reached", "x-example": "", - "items": { - "$ref": "#\/components\/schemas\/billingLimits" - }, + "allOf": [ + { + "$ref": "#\/components\/schemas\/billingLimits" + } + ], "nullable": true }, "oAuth2ServerEnabled": { @@ -98040,65 +100850,81 @@ "type": "object", "description": "Aggregated number of text embedding calls per period.", "x-example": [], - "items": { - "$ref": "#\/components\/schemas\/metric" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/metric" + } + ] }, "embeddingsTextTokens": { "type": "object", "description": "Aggregated number of tokens processed by text embeddings per period.", "x-example": [], - "items": { - "$ref": "#\/components\/schemas\/metric" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/metric" + } + ] }, "embeddingsTextDuration": { "type": "object", "description": "Aggregated duration spent generating text embeddings per period.", "x-example": [], - "items": { - "$ref": "#\/components\/schemas\/metric" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/metric" + } + ] }, "embeddingsTextErrors": { "type": "object", "description": "Aggregated number of errors while generating text embeddings per period.", "x-example": [], - "items": { - "$ref": "#\/components\/schemas\/metric" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/metric" + } + ] }, "embeddingsTextTotal": { "type": "object", "description": "Total aggregated number of text embedding calls.", "x-example": 0, - "items": { - "$ref": "#\/components\/schemas\/metric" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/metric" + } + ] }, "embeddingsTextTokensTotal": { "type": "object", "description": "Total aggregated number of tokens processed by text.", "x-example": 0, - "items": { - "$ref": "#\/components\/schemas\/metric" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/metric" + } + ] }, "embeddingsTextDurationTotal": { "type": "object", "description": "Total aggregated duration spent generating text embeddings.", "x-example": 0, - "items": { - "$ref": "#\/components\/schemas\/metric" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/metric" + } + ] }, "embeddingsTextErrorsTotal": { "type": "object", "description": "Total aggregated number of errors while generating text embeddings.", "x-example": 0, - "items": { - "$ref": "#\/components\/schemas\/metric" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/metric" + } + ] }, "functionsExecutions": { "type": "array", @@ -98603,6 +101429,7 @@ }, "data": { "type": "object", + "additionalProperties": true, "description": "Schedule data used to store resource-specific context needed for execution.", "x-example": [] }, @@ -99239,6 +102066,7 @@ }, "credentials": { "type": "object", + "additionalProperties": true, "description": "Provider credentials.", "x-example": { "key": "123456789" @@ -99246,11 +102074,11 @@ }, "options": { "type": "object", + "additionalProperties": true, "description": "Provider options.", "x-example": { "from": "sender-email@mydomain" - }, - "nullable": true + } } }, "required": [ @@ -99364,6 +102192,7 @@ }, "data": { "type": "object", + "additionalProperties": true, "description": "Data of the message.", "x-example": { "subject": "Welcome to Appwrite", @@ -99584,9 +102413,11 @@ "identifier": "random-mail@email.org", "userId": "5e5ea5c16897e" }, - "items": { - "$ref": "#\/components\/schemas\/target" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/target" + } + ] }, "userId": { "type": "string", @@ -99770,11 +102601,13 @@ }, "statusCounters": { "type": "object", + "additionalProperties": true, "description": "A group of counters that represent the total progress of the migration.", "x-example": "{\"Database\": {\"PENDING\": 0, \"SUCCESS\": 1, \"ERROR\": 0, \"SKIP\": 0, \"PROCESSING\": 0, \"WARNING\": 0}}" }, "resourceData": { "type": "object", + "additionalProperties": true, "description": "An array of objects containing the report data of the resources that were migrated.", "x-example": "[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]" }, @@ -99788,6 +102621,7 @@ }, "options": { "type": "object", + "additionalProperties": true, "description": "Migration options used during the migration process.", "x-example": "{\"bucketId\": \"exports\", \"notify\": false}" } @@ -100211,6 +103045,7 @@ }, "params": { "type": "object", + "additionalProperties": true, "description": "Parameter map the client should pass to the service method when this CTA is triggered. Keys match the target API's parameter names (e.g. databaseId\/tableId\/columns for tablesDB, databaseId\/collectionId\/attributes for the legacy Databases API).", "x-example": { "databaseId": "main", @@ -101650,17 +104485,21 @@ "type": "object", "description": "Additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/usageBillingPlan" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/usageBillingPlan" + } + ] }, "addons": { "type": "object", "description": "Addons", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/billingPlanAddon" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/billingPlanAddon" + } + ] }, "budgetCapEnabled": { "type": "boolean", @@ -101756,9 +104595,11 @@ "type": "object", "description": "Supported addons for this plan", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/billingPlanSupportedAddons" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/billingPlanSupportedAddons" + } + ] }, "backupPolicies": { "type": "integer", @@ -101787,9 +104628,11 @@ "type": "object", "description": "Plan specific limits", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/billingPlanLimits" - }, + "allOf": [ + { + "$ref": "#\/components\/schemas\/billingPlanLimits" + } + ], "nullable": true }, "group": { @@ -101806,9 +104649,11 @@ "type": "object", "description": "Details of the program this plan is a part of.", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/program" - }, + "allOf": [ + { + "$ref": "#\/components\/schemas\/program" + } + ], "nullable": true } }, @@ -101951,17 +104796,21 @@ "type": "object", "description": "Addon seats", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/billingPlanAddonDetails" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/billingPlanAddonDetails" + } + ] }, "projects": { "type": "object", "description": "Addon projects", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/billingPlanAddonDetails" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/billingPlanAddonDetails" + } + ] } }, "required": [ @@ -102358,9 +105207,9 @@ }, "image": { "type": "object", + "additionalProperties": true, "description": "Campaign images", - "x-example": "", - "nullable": true + "x-example": "" }, "reviews": { "type": "array", @@ -103151,11 +106000,9 @@ "type": "object", "properties": { "rows": { - "type": "array", + "type": "object", + "additionalProperties": true, "description": "Result rows as a list of column-name => value maps. Empty for non-returning statements.", - "items": { - "type": "object" - }, "x-example": [ { "id": 1, @@ -103365,9 +106212,11 @@ "current": 12, "max": 100 }, - "items": { - "$ref": "#\/components\/schemas\/databaseStatusConnections" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/databaseStatusConnections" + } + ] }, "replicas": { "type": "array", @@ -104129,17 +106978,21 @@ "type": "object", "description": "Cost estimation details", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/planChangeEstimationDetails" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/planChangeEstimationDetails" + } + ] }, "limits": { "type": "object", "description": "Plan limits and compliance information", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/planChangeLimits" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/planChangeLimits" + } + ] } }, "required": [ @@ -104590,9 +107443,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "$ref": "#\/components\/schemas\/preferences" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/preferences" + } + ] }, "billingBudget": { "type": "integer", @@ -104626,9 +107481,11 @@ "type": "object", "description": "Organization's billing plan.", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/billingPlan" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/billingPlan" + } + ] }, "billingEmail": { "type": "string", @@ -104725,9 +107582,11 @@ "type": "object", "description": "Billing limits reached", "x-example": "", - "items": { - "$ref": "#\/components\/schemas\/billingLimits" - }, + "allOf": [ + { + "$ref": "#\/components\/schemas\/billingLimits" + } + ], "nullable": true }, "billingPlanDowngrade": { @@ -105112,11 +107971,9 @@ "x-example": "2025-12-01T00:00:00.000Z" }, "items": { - "type": "array", + "type": "object", + "additionalProperties": true, "description": "Line items breakdown", - "items": { - "type": "object" - }, "x-example": [ { "label": "Starter plan", @@ -105129,11 +107986,9 @@ ] }, "discounts": { - "type": "array", + "type": "object", + "additionalProperties": true, "description": "Applied discounts breakdown", - "items": { - "type": "object" - }, "x-example": [ { "label": "Organization credits", @@ -105402,6 +108257,11 @@ "description": "Policy backup schedule in CRON format.", "x-example": "0 * * * *" }, + "type": { + "type": "string", + "description": "Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup).", + "x-example": "full" + }, "enabled": { "type": "boolean", "description": "Is this policy enabled.", @@ -105417,6 +108277,7 @@ "resources", "retention", "schedule", + "type", "enabled" ], "example": { @@ -105430,6 +108291,7 @@ "resourceType": "database", "retention": 7, "schedule": "0 * * * *", + "type": "full", "enabled": true } }, @@ -106077,9 +108939,11 @@ "type": "object", "description": "Overage and add-on pricing shared across all specifications.", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/dedicatedDatabaseSpecificationPricing" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/dedicatedDatabaseSpecificationPricing" + } + ] } }, "required": [ @@ -106263,89 +109127,111 @@ "type": "object", "description": "Bandwidth additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] }, "executions": { "type": "object", "description": "Executions additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] }, "member": { "type": "object", "description": "Member additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] }, "realtime": { "type": "object", "description": "Realtime additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] }, "realtimeMessages": { "type": "object", "description": "Realtime messages additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] }, "realtimeBandwidth": { "type": "object", "description": "Realtime bandwidth additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] }, "storage": { "type": "object", "description": "Storage additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] }, "users": { "type": "object", "description": "User additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] }, "GBHours": { "type": "object", "description": "GBHour additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] }, "imageTransformations": { "type": "object", "description": "Image transformation additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] }, "credits": { "type": "object", "description": "Credits additional resources", "x-example": null, - "items": { - "$ref": "#\/components\/schemas\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/additionalResource" + } + ] } }, "required": [ diff --git a/specs/1.9.x/open-api3-1.9.x-server.json b/specs/1.9.x/open-api3-1.9.x-server.json index 39c5d294..fce2f861 100644 --- a/specs/1.9.x/open-api3-1.9.x-server.json +++ b/specs/1.9.x/open-api3-1.9.x-server.json @@ -737,7 +737,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -866,7 +869,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -1001,7 +1007,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -1133,7 +1142,13 @@ "totp", "recoverycode" ], - "x-enum-name": "AuthenticationFactor" + "x-enum-name": "AuthenticationFactor", + "x-enum-keys": [ + "email", + "phone", + "totp", + "recoverycode" + ] } }, "required": [ @@ -2034,6 +2049,7 @@ "prefs": { "type": "object", "description": "Prefs key-value JSON object.", + "default": {}, "x-example": "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}" } }, @@ -3129,7 +3145,15 @@ "description": "Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).", "responses": { "301": { - "description": "File" + "description": "No content", + "content": { + "text\/html": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -3216,7 +3240,52 @@ "zoho", "zoom" ], - "x-enum-name": "OAuthProvider" + "x-enum-name": "OAuthProvider", + "x-enum-keys": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom" + ] }, "in": "path" }, @@ -3898,7 +3967,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -3976,7 +4044,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4134,7 +4201,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4198,7 +4264,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4344,11 +4409,13 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [], "Session": [] @@ -4410,7 +4477,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4498,7 +4564,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4564,7 +4629,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4631,11 +4695,13 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [], "Session": [] @@ -4707,7 +4773,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4785,11 +4850,13 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [], "Session": [] @@ -4827,7 +4894,15 @@ "description": "You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -4844,7 +4919,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -4958,7 +5032,15 @@ "description": "The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -4975,7 +5057,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5095,7 +5176,15 @@ "description": "Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n\nThis endpoint does not follow HTTP redirects.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5112,7 +5201,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5158,7 +5246,15 @@ "description": "You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5175,7 +5271,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5651,7 +5746,15 @@ "description": "Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n\nThis endpoint does not follow HTTP redirects.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5668,7 +5771,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5738,7 +5840,15 @@ "description": "Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5755,7 +5865,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5835,7 +5944,15 @@ "description": "Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5852,7 +5969,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5932,7 +6048,15 @@ "description": "Use this endpoint to capture a screenshot of any website URL. This endpoint uses a headless browser to render the webpage and capture it as an image.\n\nYou can configure the browser viewport size, theme, user agent, geolocation, permissions, and more. Capture either just the viewport or the full page scroll.\n\nWhen width and height are specified, the image is resized accordingly. If both dimensions are 0, the API provides an image at original size. If dimensions are not specified, the default viewport size is 1280x720px.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/png": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -5949,7 +6073,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -5988,8 +6111,8 @@ "required": false, "schema": { "type": "object", - "x-example": "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}", - "default": {} + "default": [], + "x-example": "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}" }, "in": "query" }, @@ -6041,6 +6164,10 @@ "dark" ], "x-enum-name": "BrowserTheme", + "x-enum-keys": [ + "light", + "dark" + ], "default": "light" }, "in": "query" @@ -6506,7 +6633,428 @@ "pacific\/wallis", "utc" ], - "x-enum-name": "Timezone" + "x-enum-name": "Timezone", + "x-enum-keys": [ + "africa\/abidjan", + "africa\/accra", + "africa\/addis_ababa", + "africa\/algiers", + "africa\/asmara", + "africa\/bamako", + "africa\/bangui", + "africa\/banjul", + "africa\/bissau", + "africa\/blantyre", + "africa\/brazzaville", + "africa\/bujumbura", + "africa\/cairo", + "africa\/casablanca", + "africa\/ceuta", + "africa\/conakry", + "africa\/dakar", + "africa\/dar_es_salaam", + "africa\/djibouti", + "africa\/douala", + "africa\/el_aaiun", + "africa\/freetown", + "africa\/gaborone", + "africa\/harare", + "africa\/johannesburg", + "africa\/juba", + "africa\/kampala", + "africa\/khartoum", + "africa\/kigali", + "africa\/kinshasa", + "africa\/lagos", + "africa\/libreville", + "africa\/lome", + "africa\/luanda", + "africa\/lubumbashi", + "africa\/lusaka", + "africa\/malabo", + "africa\/maputo", + "africa\/maseru", + "africa\/mbabane", + "africa\/mogadishu", + "africa\/monrovia", + "africa\/nairobi", + "africa\/ndjamena", + "africa\/niamey", + "africa\/nouakchott", + "africa\/ouagadougou", + "africa\/porto-novo", + "africa\/sao_tome", + "africa\/tripoli", + "africa\/tunis", + "africa\/windhoek", + "america\/adak", + "america\/anchorage", + "america\/anguilla", + "america\/antigua", + "america\/araguaina", + "america\/argentina\/buenos_aires", + "america\/argentina\/catamarca", + "america\/argentina\/cordoba", + "america\/argentina\/jujuy", + "america\/argentina\/la_rioja", + "america\/argentina\/mendoza", + "america\/argentina\/rio_gallegos", + "america\/argentina\/salta", + "america\/argentina\/san_juan", + "america\/argentina\/san_luis", + "america\/argentina\/tucuman", + "america\/argentina\/ushuaia", + "america\/aruba", + "america\/asuncion", + "america\/atikokan", + "america\/bahia", + "america\/bahia_banderas", + "america\/barbados", + "america\/belem", + "america\/belize", + "america\/blanc-sablon", + "america\/boa_vista", + "america\/bogota", + "america\/boise", + "america\/cambridge_bay", + "america\/campo_grande", + "america\/cancun", + "america\/caracas", + "america\/cayenne", + "america\/cayman", + "america\/chicago", + "america\/chihuahua", + "america\/ciudad_juarez", + "america\/costa_rica", + "america\/coyhaique", + "america\/creston", + "america\/cuiaba", + "america\/curacao", + "america\/danmarkshavn", + "america\/dawson", + "america\/dawson_creek", + "america\/denver", + "america\/detroit", + "america\/dominica", + "america\/edmonton", + "america\/eirunepe", + "america\/el_salvador", + "america\/fort_nelson", + "america\/fortaleza", + "america\/glace_bay", + "america\/goose_bay", + "america\/grand_turk", + "america\/grenada", + "america\/guadeloupe", + "america\/guatemala", + "america\/guayaquil", + "america\/guyana", + "america\/halifax", + "america\/havana", + "america\/hermosillo", + "america\/indiana\/indianapolis", + "america\/indiana\/knox", + "america\/indiana\/marengo", + "america\/indiana\/petersburg", + "america\/indiana\/tell_city", + "america\/indiana\/vevay", + "america\/indiana\/vincennes", + "america\/indiana\/winamac", + "america\/inuvik", + "america\/iqaluit", + "america\/jamaica", + "america\/juneau", + "america\/kentucky\/louisville", + "america\/kentucky\/monticello", + "america\/kralendijk", + "america\/la_paz", + "america\/lima", + "america\/los_angeles", + "america\/lower_princes", + "america\/maceio", + "america\/managua", + "america\/manaus", + "america\/marigot", + "america\/martinique", + "america\/matamoros", + "america\/mazatlan", + "america\/menominee", + "america\/merida", + "america\/metlakatla", + "america\/mexico_city", + "america\/miquelon", + "america\/moncton", + "america\/monterrey", + "america\/montevideo", + "america\/montserrat", + "america\/nassau", + "america\/new_york", + "america\/nome", + "america\/noronha", + "america\/north_dakota\/beulah", + "america\/north_dakota\/center", + "america\/north_dakota\/new_salem", + "america\/nuuk", + "america\/ojinaga", + "america\/panama", + "america\/paramaribo", + "america\/phoenix", + "america\/port-au-prince", + "america\/port_of_spain", + "america\/porto_velho", + "america\/puerto_rico", + "america\/punta_arenas", + "america\/rankin_inlet", + "america\/recife", + "america\/regina", + "america\/resolute", + "america\/rio_branco", + "america\/santarem", + "america\/santiago", + "america\/santo_domingo", + "america\/sao_paulo", + "america\/scoresbysund", + "america\/sitka", + "america\/st_barthelemy", + "america\/st_johns", + "america\/st_kitts", + "america\/st_lucia", + "america\/st_thomas", + "america\/st_vincent", + "america\/swift_current", + "america\/tegucigalpa", + "america\/thule", + "america\/tijuana", + "america\/toronto", + "america\/tortola", + "america\/vancouver", + "america\/whitehorse", + "america\/winnipeg", + "america\/yakutat", + "antarctica\/casey", + "antarctica\/davis", + "antarctica\/dumontdurville", + "antarctica\/macquarie", + "antarctica\/mawson", + "antarctica\/mcmurdo", + "antarctica\/palmer", + "antarctica\/rothera", + "antarctica\/syowa", + "antarctica\/troll", + "antarctica\/vostok", + "arctic\/longyearbyen", + "asia\/aden", + "asia\/almaty", + "asia\/amman", + "asia\/anadyr", + "asia\/aqtau", + "asia\/aqtobe", + "asia\/ashgabat", + "asia\/atyrau", + "asia\/baghdad", + "asia\/bahrain", + "asia\/baku", + "asia\/bangkok", + "asia\/barnaul", + "asia\/beirut", + "asia\/bishkek", + "asia\/brunei", + "asia\/chita", + "asia\/colombo", + "asia\/damascus", + "asia\/dhaka", + "asia\/dili", + "asia\/dubai", + "asia\/dushanbe", + "asia\/famagusta", + "asia\/gaza", + "asia\/hebron", + "asia\/ho_chi_minh", + "asia\/hong_kong", + "asia\/hovd", + "asia\/irkutsk", + "asia\/jakarta", + "asia\/jayapura", + "asia\/jerusalem", + "asia\/kabul", + "asia\/kamchatka", + "asia\/karachi", + "asia\/kathmandu", + "asia\/khandyga", + "asia\/kolkata", + "asia\/krasnoyarsk", + "asia\/kuala_lumpur", + "asia\/kuching", + "asia\/kuwait", + "asia\/macau", + "asia\/magadan", + "asia\/makassar", + "asia\/manila", + "asia\/muscat", + "asia\/nicosia", + "asia\/novokuznetsk", + "asia\/novosibirsk", + "asia\/omsk", + "asia\/oral", + "asia\/phnom_penh", + "asia\/pontianak", + "asia\/pyongyang", + "asia\/qatar", + "asia\/qostanay", + "asia\/qyzylorda", + "asia\/riyadh", + "asia\/sakhalin", + "asia\/samarkand", + "asia\/seoul", + "asia\/shanghai", + "asia\/singapore", + "asia\/srednekolymsk", + "asia\/taipei", + "asia\/tashkent", + "asia\/tbilisi", + "asia\/tehran", + "asia\/thimphu", + "asia\/tokyo", + "asia\/tomsk", + "asia\/ulaanbaatar", + "asia\/urumqi", + "asia\/ust-nera", + "asia\/vientiane", + "asia\/vladivostok", + "asia\/yakutsk", + "asia\/yangon", + "asia\/yekaterinburg", + "asia\/yerevan", + "atlantic\/azores", + "atlantic\/bermuda", + "atlantic\/canary", + "atlantic\/cape_verde", + "atlantic\/faroe", + "atlantic\/madeira", + "atlantic\/reykjavik", + "atlantic\/south_georgia", + "atlantic\/st_helena", + "atlantic\/stanley", + "australia\/adelaide", + "australia\/brisbane", + "australia\/broken_hill", + "australia\/darwin", + "australia\/eucla", + "australia\/hobart", + "australia\/lindeman", + "australia\/lord_howe", + "australia\/melbourne", + "australia\/perth", + "australia\/sydney", + "europe\/amsterdam", + "europe\/andorra", + "europe\/astrakhan", + "europe\/athens", + "europe\/belgrade", + "europe\/berlin", + "europe\/bratislava", + "europe\/brussels", + "europe\/bucharest", + "europe\/budapest", + "europe\/busingen", + "europe\/chisinau", + "europe\/copenhagen", + "europe\/dublin", + "europe\/gibraltar", + "europe\/guernsey", + "europe\/helsinki", + "europe\/isle_of_man", + "europe\/istanbul", + "europe\/jersey", + "europe\/kaliningrad", + "europe\/kirov", + "europe\/kyiv", + "europe\/lisbon", + "europe\/ljubljana", + "europe\/london", + "europe\/luxembourg", + "europe\/madrid", + "europe\/malta", + "europe\/mariehamn", + "europe\/minsk", + "europe\/monaco", + "europe\/moscow", + "europe\/oslo", + "europe\/paris", + "europe\/podgorica", + "europe\/prague", + "europe\/riga", + "europe\/rome", + "europe\/samara", + "europe\/san_marino", + "europe\/sarajevo", + "europe\/saratov", + "europe\/simferopol", + "europe\/skopje", + "europe\/sofia", + "europe\/stockholm", + "europe\/tallinn", + "europe\/tirane", + "europe\/ulyanovsk", + "europe\/vaduz", + "europe\/vatican", + "europe\/vienna", + "europe\/vilnius", + "europe\/volgograd", + "europe\/warsaw", + "europe\/zagreb", + "europe\/zurich", + "indian\/antananarivo", + "indian\/chagos", + "indian\/christmas", + "indian\/cocos", + "indian\/comoro", + "indian\/kerguelen", + "indian\/mahe", + "indian\/maldives", + "indian\/mauritius", + "indian\/mayotte", + "indian\/reunion", + "pacific\/apia", + "pacific\/auckland", + "pacific\/bougainville", + "pacific\/chatham", + "pacific\/chuuk", + "pacific\/easter", + "pacific\/efate", + "pacific\/fakaofo", + "pacific\/fiji", + "pacific\/funafuti", + "pacific\/galapagos", + "pacific\/gambier", + "pacific\/guadalcanal", + "pacific\/guam", + "pacific\/honolulu", + "pacific\/kanton", + "pacific\/kiritimati", + "pacific\/kosrae", + "pacific\/kwajalein", + "pacific\/majuro", + "pacific\/marquesas", + "pacific\/midway", + "pacific\/nauru", + "pacific\/niue", + "pacific\/norfolk", + "pacific\/noumea", + "pacific\/pago_pago", + "pacific\/palau", + "pacific\/pitcairn", + "pacific\/pohnpei", + "pacific\/port_moresby", + "pacific\/rarotonga", + "pacific\/saipan", + "pacific\/tahiti", + "pacific\/tarawa", + "pacific\/tongatapu", + "pacific\/wake", + "pacific\/wallis", + "utc" + ] }, "in": "query" }, @@ -6587,7 +7135,29 @@ "web-share", "xr-spatial-tracking" ], - "x-enum-name": "BrowserPermission" + "x-enum-name": "BrowserPermission", + "x-enum-keys": [ + "geolocation", + "camera", + "microphone", + "notifications", + "midi", + "push", + "clipboard-read", + "clipboard-write", + "payment-handler", + "usb", + "bluetooth", + "accelerometer", + "gyroscope", + "magnetometer", + "ambient-light-sensor", + "background-sync", + "persistent-storage", + "screen-wake-lock", + "web-share", + "xr-spatial-tracking" + ] }, "x-example": "[\"geolocation\",\"notifications\"]", "default": [] @@ -6658,7 +7228,16 @@ "avif", "gif" ], - "x-enum-name": "ImageFormat" + "x-enum-name": "ImageFormat", + "x-enum-keys": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ] }, "in": "query" } @@ -6799,7 +7378,16 @@ "functions", "storage" ], - "x-enum-name": "BackupServices" + "x-enum-name": "BackupServices", + "x-enum-keys": [ + "databases", + "tablesdb", + "documentsdb", + "vectorsdb", + "dedicatedDatabases", + "functions", + "storage" + ] } }, "resourceId": { @@ -6910,6 +7498,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/backups\/delete-archive.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [], "Key": [] @@ -7092,7 +7683,16 @@ "functions", "storage" ], - "x-enum-name": "BackupServices" + "x-enum-name": "BackupServices", + "x-enum-keys": [ + "databases", + "tablesdb", + "documentsdb", + "vectorsdb", + "dedicatedDatabases", + "functions", + "storage" + ] } }, "resourceId": { @@ -7328,6 +7928,9 @@ "packaging": false, "public": true, "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/backups\/delete-policy.md", + "produces": [ + "application\/json" + ], "auth": { "Project": [], "Key": [] @@ -7431,7 +8034,16 @@ "functions", "storage" ], - "x-enum-name": "BackupServices" + "x-enum-name": "BackupServices", + "x-enum-keys": [ + "databases", + "tablesdb", + "documentsdb", + "vectorsdb", + "dedicatedDatabases", + "functions", + "storage" + ] } }, "newResourceId": { @@ -7865,8 +8477,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -7933,8 +8544,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -8006,8 +8616,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -8071,8 +8680,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -8152,8 +8760,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -8219,8 +8826,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -11237,11 +11843,11 @@ "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "array", + "items": { + "type": "number", + "format": "double" + } }, "x-nullable": true } @@ -11356,11 +11962,11 @@ "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "array", + "items": { + "type": "number", + "format": "double" + } }, "x-nullable": true }, @@ -11496,21 +12102,251 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext\/{key}": { + "patch": { + "summary": "Update longtext attribute", + "operationId": "databasesUpdateLongtextAttribute", + "tags": [ + "databases" + ], + "description": "Update a longtext attribute. Changing the `default` value will not update already existing documents.\n", + "responses": { + "200": { + "description": "AttributeLongtext", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeLongtext" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateLongtextAttribute", + "group": "attributes", + "cookies": false, + "type": "", + "demo": "databases\/update-longtext-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-longtext-attribute.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "", + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "x-example": null, + "x-nullable": true + } + }, + "required": [ + "required", + "default" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext": { + "post": { + "summary": "Create mediumtext attribute", + "operationId": "databasesCreateMediumtextAttribute", + "tags": [ + "databases" + ], + "description": "Create a mediumtext attribute.\n", + "responses": { + "202": { + "description": "AttributeMediumtext", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeMediumtext" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createMediumtextAttribute", + "group": "attributes", + "cookies": false, + "type": "", + "demo": "databases\/create-mediumtext-attribute.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-mediumtext-attribute.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": null + }, + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "", + "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "default": false, + "x-example": false + } + }, + "required": [ + "key", + "required" + ] + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext\/{key}": { "patch": { - "summary": "Update longtext attribute", - "operationId": "databasesUpdateLongtextAttribute", + "summary": "Update mediumtext attribute", + "operationId": "databasesUpdateMediumtextAttribute", "tags": [ "databases" ], - "description": "Update a longtext attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a mediumtext attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeLongtext", + "description": "AttributeMediumtext", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeLongtext" + "$ref": "#\/components\/schemas\/attributeMediumtext" } } } @@ -11518,11 +12354,11 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLongtextAttribute", + "method": "updateMediumtextAttribute", "group": "attributes", "cookies": false, "type": "", - "demo": "databases\/update-longtext-attribute.md", + "demo": "databases\/update-mediumtext-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11533,7 +12369,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-longtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-mediumtext-attribute.md", "auth": { "Project": [], "Key": [] @@ -11610,33 +12446,33 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": { "post": { - "summary": "Create mediumtext attribute", - "operationId": "databasesCreateMediumtextAttribute", + "summary": "Create point attribute", + "operationId": "databasesCreatePointAttribute", "tags": [ "databases" ], - "description": "Create a mediumtext attribute.\n", + "description": "Create a geometric point attribute.", "responses": { "202": { - "description": "AttributeMediumtext", + "description": "AttributePoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeMediumtext" + "$ref": "#\/components\/schemas\/attributePoint" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createMediumtextAttribute", + "method": "createPointAttribute", "group": "attributes", "cookies": false, "type": "", - "demo": "databases\/create-mediumtext-attribute.md", + "demo": "databases\/create-point-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11647,7 +12483,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-mediumtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createPointColumn" + }, "auth": { "Project": [], "Key": [] @@ -11698,22 +12538,14 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "type": "array", + "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.", + "x-example": "[1, 2]", + "items": { + "type": "number", + "format": "double" + }, "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false } }, "required": [ @@ -11726,33 +12558,33 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": { "patch": { - "summary": "Update mediumtext attribute", - "operationId": "databasesUpdateMediumtextAttribute", + "summary": "Update point attribute", + "operationId": "databasesUpdatePointAttribute", "tags": [ "databases" ], - "description": "Update a mediumtext attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a point attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeMediumtext", + "description": "AttributePoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeMediumtext" + "$ref": "#\/components\/schemas\/attributePoint" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateMediumtextAttribute", + "method": "updatePointAttribute", "group": "attributes", "cookies": false, "type": "", - "demo": "databases\/update-mediumtext-attribute.md", + "demo": "databases\/update-point-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11763,7 +12595,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-mediumtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updatePointColumn" + }, "auth": { "Project": [], "Key": [] @@ -11788,7 +12624,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", "required": true, "schema": { "type": "string", @@ -11818,21 +12654,24 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "type": "array", + "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.", + "x-example": "[1, 2]", + "items": { + "type": "number", + "format": "double" + }, "x-nullable": true }, "newKey": { "type": "string", - "description": "New Attribute Key.", + "description": "New attribute key.", "x-example": null, "x-nullable": true } }, "required": [ - "required", - "default" + "required" ] } } @@ -11840,21 +12679,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": { "post": { - "summary": "Create point attribute", - "operationId": "databasesCreatePointAttribute", + "summary": "Create polygon attribute", + "operationId": "databasesCreatePolygonAttribute", "tags": [ "databases" ], - "description": "Create a geometric point attribute.", + "description": "Create a geometric polygon attribute.", "responses": { "202": { - "description": "AttributePoint", + "description": "AttributePolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePoint" + "$ref": "#\/components\/schemas\/attributePolygon" } } } @@ -11862,11 +12701,11 @@ }, "deprecated": true, "x-appwrite": { - "method": "createPointAttribute", + "method": "createPolygonAttribute", "group": "attributes", "cookies": false, "type": "", - "demo": "databases\/create-point-attribute.md", + "demo": "databases\/create-polygon-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11877,10 +12716,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createPointColumn" + "replaceWith": "tablesDB.createPolygonColumn" }, "auth": { "Project": [], @@ -11933,14 +12772,17 @@ }, "default": { "type": "array", - "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.", - "x-example": "[1, 2]", + "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "items": { - "oneOf": [ - { - "type": "array" + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - ] + } }, "x-nullable": true } @@ -11955,21 +12797,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": { "patch": { - "summary": "Update point attribute", - "operationId": "databasesUpdatePointAttribute", + "summary": "Update polygon attribute", + "operationId": "databasesUpdatePolygonAttribute", "tags": [ "databases" ], - "description": "Update a point attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributePoint", + "description": "AttributePolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePoint" + "$ref": "#\/components\/schemas\/attributePolygon" } } } @@ -11977,11 +12819,11 @@ }, "deprecated": true, "x-appwrite": { - "method": "updatePointAttribute", + "method": "updatePolygonAttribute", "group": "attributes", "cookies": false, "type": "", - "demo": "databases\/update-point-attribute.md", + "demo": "databases\/update-polygon-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11992,10 +12834,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updatePointColumn" + "replaceWith": "tablesDB.updatePolygonColumn" }, "auth": { "Project": [], @@ -12052,14 +12894,17 @@ }, "default": { "type": "array", - "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.", - "x-example": "[1, 2]", + "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "items": { - "oneOf": [ - { - "type": "array" + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - ] + } }, "x-nullable": true }, @@ -12079,21 +12924,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": { "post": { - "summary": "Create polygon attribute", - "operationId": "databasesCreatePolygonAttribute", + "summary": "Create relationship attribute", + "operationId": "databasesCreateRelationshipAttribute", "tags": [ "databases" ], - "description": "Create a geometric polygon attribute.", + "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "202": { - "description": "AttributePolygon", + "description": "AttributeRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePolygon" + "$ref": "#\/components\/schemas\/attributeRelationship" } } } @@ -12101,11 +12946,11 @@ }, "deprecated": true, "x-appwrite": { - "method": "createPolygonAttribute", + "method": "createRelationshipAttribute", "group": "attributes", "cookies": false, "type": "", - "demo": "databases\/create-polygon-attribute.md", + "demo": "databases\/create-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12116,10 +12961,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createPolygonColumn" + "replaceWith": "tablesDB.createRelationshipColumn" }, "auth": { "Project": [], @@ -12145,7 +12990,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -12160,33 +13005,68 @@ "schema": { "type": "object", "properties": { - "key": { + "relatedCollectionId": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Related Collection ID.", + "x-example": "" }, - "required": { + "type": { + "type": "string", + "description": "Relation type", + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": "RelationshipType", + "x-enum-keys": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ] + }, + "twoWay": { "type": "boolean", - "description": "Is attribute required?", + "description": "Is Two Way?", + "default": false, "x-example": false }, - "default": { - "type": "array", - "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.", - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": null, + "x-nullable": true + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Attribute Key.", + "x-example": null, "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [ + "cascade", + "restrict", + "setNull" + ] } }, "required": [ - "key", - "required" + "relatedCollectionId", + "type" ] } } @@ -12194,21 +13074,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { "patch": { - "summary": "Update polygon attribute", - "operationId": "databasesUpdatePolygonAttribute", + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", "tags": [ "databases" ], - "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.", + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "200": { - "description": "AttributePolygon", + "description": "AttributeRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePolygon" + "$ref": "#\/components\/schemas\/attributeRelationship" } } } @@ -12216,11 +13096,11 @@ }, "deprecated": true, "x-appwrite": { - "method": "updatePolygonAttribute", + "method": "updateRelationshipAttribute", "group": "attributes", "cookies": false, "type": "", - "demo": "databases\/update-polygon-attribute.md", + "demo": "databases\/update-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12231,10 +13111,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updatePolygonColumn" + "replaceWith": "tablesDB.updateRelationshipColumn" }, "auth": { "Project": [], @@ -12260,7 +13140,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -12284,279 +13164,21 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false - }, - "default": { - "type": "array", - "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.", - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "items": { - "oneOf": [ - { - "type": "array" - } - ] - }, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New attribute key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required" - ] - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": { - "post": { - "summary": "Create relationship attribute", - "operationId": "databasesCreateRelationshipAttribute", - "tags": [ - "databases" - ], - "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", - "responses": { - "202": { - "description": "AttributeRelationship", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/attributeRelationship" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "createRelationshipAttribute", - "group": "attributes", - "cookies": false, - "type": "", - "demo": "databases\/create-relationship-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createRelationshipColumn" - }, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "relatedCollectionId": { - "type": "string", - "description": "Related Collection ID.", - "x-example": "" - }, - "type": { - "type": "string", - "description": "Relation type", - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType" - }, - "twoWay": { - "type": "boolean", - "description": "Is Two Way?", - "default": false, - "x-example": false - }, - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null, - "x-nullable": true - }, - "twoWayKey": { - "type": "string", - "description": "Two Way Attribute Key.", - "x-example": null, - "x-nullable": true - }, "onDelete": { "type": "string", "description": "Constraints option", - "default": "restrict", "x-example": "cascade", "enum": [ "cascade", "restrict", "setNull" ], - "x-enum-name": "RelationMutate" - } - }, - "required": [ - "relatedCollectionId", - "type" - ] - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { - "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", - "tags": [ - "databases" - ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", - "responses": { - "200": { - "description": "AttributeRelationship", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/attributeRelationship" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "updateRelationshipAttribute", - "group": "attributes", - "cookies": false, - "type": "", - "demo": "databases\/update-relationship-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" - }, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ + "x-enum-name": "RelationMutate", + "x-enum-keys": [ "cascade", "restrict", "setNull" - ], - "x-enum-name": "RelationMutate" + ] }, "newKey": { "type": "string", @@ -13810,7 +14432,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -13935,7 +14556,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14069,7 +14689,7 @@ "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -14323,7 +14943,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "queries": { @@ -14419,34 +15039,31 @@ "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { @@ -14483,7 +15100,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14595,7 +15211,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14699,7 +15314,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -14756,7 +15371,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14820,7 +15434,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "permissions": { @@ -14870,7 +15484,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -14923,25 +15536,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { @@ -14978,8 +15584,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -15109,8 +15714,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -15401,7 +16005,13 @@ "unique", "spatial" ], - "x-enum-name": "DatabasesIndexType" + "x-enum-name": "DatabasesIndexType", + "x-enum-keys": [ + "key", + "fulltext", + "unique", + "spatial" + ] }, "attributes": { "type": "array", @@ -15422,7 +16032,11 @@ "asc", "desc" ], - "x-enum-name": "OrderBy" + "x-enum-name": "OrderBy", + "x-enum-keys": [ + "asc", + "desc" + ] } }, "lengths": { @@ -15812,8 +16426,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -15880,8 +16493,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -15953,8 +16565,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -16018,8 +16629,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -16099,8 +16709,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -16165,8 +16774,7 @@ "scope": "documents.write", "platforms": [ "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -16934,7 +17542,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -17055,7 +17662,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -17175,7 +17781,7 @@ "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -17414,7 +18020,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{}" }, "queries": { @@ -17505,33 +18111,31 @@ "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } + ] } }, "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { @@ -17568,7 +18172,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -17676,7 +18279,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -17769,7 +18371,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -17824,7 +18426,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -17884,7 +18485,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -17932,7 +18533,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -17981,24 +18581,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } + ] } }, "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { @@ -18035,8 +18629,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -18160,8 +18753,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -18437,7 +19029,12 @@ "fulltext", "unique" ], - "x-enum-name": "DocumentsDBIndexType" + "x-enum-name": "DocumentsDBIndexType", + "x-enum-keys": [ + "key", + "fulltext", + "unique" + ] }, "attributes": { "type": "array", @@ -18458,7 +19055,11 @@ "asc", "desc" ], - "x-enum-name": "OrderBy" + "x-enum-name": "OrderBy", + "x-enum-keys": [ + "asc", + "desc" + ] } }, "lengths": { @@ -18889,7 +19490,103 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "Runtime" + "x-enum-name": "Runtime", + "x-enum-keys": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dart-3.12", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41", + "flutter-3.44" + ] }, "execute": { "type": "array", @@ -19052,7 +19749,106 @@ "apps.write", "usage.read" ], - "x-enum-name": "ProjectKeyScopes" + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "rules.read", + "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "dedicatedDatabases.execute", + "domains.read", + "domains.write", + "events.read", + "apps.read", + "apps.write", + "usage.read" + ] } }, "installationId": { @@ -19465,7 +20261,103 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "Runtime" + "x-enum-name": "Runtime", + "x-enum-keys": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dart-3.12", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41", + "flutter-3.44" + ] }, "execute": { "type": "array", @@ -19628,7 +20520,106 @@ "apps.write", "usage.read" ], - "x-enum-name": "ProjectKeyScopes" + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "rules.read", + "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "dedicatedDatabases.execute", + "domains.read", + "domains.write", + "events.read", + "apps.read", + "apps.write", + "usage.read" + ] } }, "installationId": { @@ -20214,7 +21205,12 @@ "branch", "tag" ], - "x-enum-name": "TemplateReferenceType" + "x-enum-name": "TemplateReferenceType", + "x-enum-keys": [ + "commit", + "branch", + "tag" + ] }, "reference": { "type": "string", @@ -20315,7 +21311,11 @@ "branch", "commit" ], - "x-enum-name": "VCSReferenceType" + "x-enum-name": "VCSReferenceType", + "x-enum-keys": [ + "branch", + "commit" + ] }, "reference": { "type": "string", @@ -20484,7 +21484,15 @@ "description": "Get 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.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "*\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -20500,7 +21508,6 @@ "scope": "functions.read", "platforms": [ "console", - "server", "server" ], "packaging": false, @@ -20552,6 +21559,10 @@ "output" ], "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [ + "source", + "output" + ], "default": "source" }, "in": "query" @@ -20668,7 +21679,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -20759,7 +21769,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -20827,12 +21836,21 @@ "OPTIONS", "HEAD" ], - "x-enum-name": "ExecutionMethod" + "x-enum-name": "ExecutionMethod", + "x-enum-keys": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ] }, "headers": { "type": "object", "description": "HTTP headers of execution. Defaults to empty.", - "default": {}, + "default": [], "x-example": "{}" }, "scheduledAt": { @@ -20885,7 +21903,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -21447,8 +22464,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -21465,7 +22481,27 @@ "Session": [], "JWT": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "type": "object", + "description": "The query or queries to execute.", + "default": {}, + "x-example": "{}" + } + }, + "required": [ + "query" + ] + } + } + } + } } }, "\/graphql\/mutation": { @@ -21502,8 +22538,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -21520,7 +22555,27 @@ "Session": [], "JWT": [] } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "type": "object", + "description": "The query or queries to execute.", + "default": {}, + "x-example": "{}" + } + }, + "required": [ + "query" + ] + } + } + } + } } }, "\/health": { @@ -22561,7 +23616,22 @@ "v1-messaging", "v1-migrations" ], - "x-enum-name": "HealthQueueName" + "x-enum-name": "HealthQueueName", + "x-enum-keys": [ + "v1-database", + "v1-deletes", + "v1-audits", + "v1-mails", + "v1-functions", + "v1-stats-resources", + "v1-stats-usage", + "v1-webhooks", + "v1-certificates", + "v1-builds", + "v1-screenshots", + "v1-messaging", + "v1-migrations" + ] }, "in": "path" }, @@ -23406,7 +24476,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -23461,7 +24530,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -23516,7 +24584,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -23571,7 +24638,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -23626,7 +24692,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -23681,7 +24746,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -23736,7 +24800,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -23791,7 +24854,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -24322,6 +25384,7 @@ "data": { "type": "object", "description": "Additional key-value pair data for push notification.", + "default": {}, "x-example": "{}", "x-nullable": true }, @@ -24402,7 +25465,11 @@ "normal", "high" ], - "x-enum-name": "MessagePriority" + "x-enum-name": "MessagePriority", + "x-enum-keys": [ + "normal", + "high" + ] } }, "required": [ @@ -24523,6 +25590,7 @@ "data": { "type": "object", "description": "Additional Data for push notification.", + "default": {}, "x-example": "{}", "x-nullable": true }, @@ -24603,6 +25671,10 @@ "high" ], "x-enum-name": "MessagePriority", + "x-enum-keys": [ + "normal", + "high" + ], "x-nullable": true } } @@ -25886,6 +26958,7 @@ "serviceAccountJSON": { "type": "object", "description": "FCM service account JSON.", + "default": {}, "x-example": "{}", "x-nullable": true }, @@ -26052,6 +27125,7 @@ "serviceAccountJSON": { "type": "object", "description": "FCM service account JSON.", + "default": {}, "x-example": "{}", "x-nullable": true } @@ -27443,7 +28517,12 @@ "ssl", "tls" ], - "x-enum-name": "SmtpEncryption" + "x-enum-name": "SmtpEncryption", + "x-enum-keys": [ + "none", + "ssl", + "tls" + ] }, "autoTLS": { "type": "boolean", @@ -27693,7 +28772,12 @@ "ssl", "tls" ], - "x-enum-name": "SmtpEncryption" + "x-enum-name": "SmtpEncryption", + "x-enum-keys": [ + "none", + "ssl", + "tls" + ] }, "autoTLS": { "type": "boolean", @@ -29465,8 +30549,7 @@ "platforms": [ "server", "client", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -29624,8 +30707,7 @@ "platforms": [ "server", "client", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -30051,7 +31133,6 @@ "scope": "oauth2.read", "platforms": [ "client", - "server", "server" ], "packaging": false, @@ -30334,7 +31415,19 @@ "keys.read", "keys.write" ], - "x-enum-name": "OrganizationKeyScopes" + "x-enum-name": "OrganizationKeyScopes", + "x-enum-keys": [ + "projects.read", + "projects.write", + "devKeys.read", + "devKeys.write", + "organization.keys.read", + "organization.keys.write", + "domains.read", + "domains.write", + "keys.read", + "keys.write" + ] } }, "expire": { @@ -30505,7 +31598,19 @@ "keys.read", "keys.write" ], - "x-enum-name": "OrganizationKeyScopes" + "x-enum-name": "OrganizationKeyScopes", + "x-enum-keys": [ + "projects.read", + "projects.write", + "devKeys.read", + "devKeys.write", + "organization.keys.read", + "organization.keys.write", + "domains.read", + "domains.write", + "keys.read", + "keys.write" + ] } }, "expire": { @@ -30740,7 +31845,15 @@ "sgp", "tor" ], - "x-enum-name": "Region" + "x-enum-name": "Region", + "x-enum-keys": [ + "fra", + "nyc", + "syd", + "sfo", + "sgp", + "tor" + ] } }, "required": [ @@ -30981,8 +32094,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -31074,8 +32186,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -31232,7 +32343,7 @@ "metadata": { "type": "object", "description": "Presence metadata object.", - "default": {}, + "default": [], "x-example": "{}" } }, @@ -31362,6 +32473,7 @@ "metadata": { "type": "object", "description": "Presence metadata object.", + "default": {}, "x-example": "{}" }, "permissions": { @@ -31410,8 +32522,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -31599,7 +32710,16 @@ "jwt", "phone" ], - "x-enum-name": "ProjectAuthMethodId" + "x-enum-name": "ProjectAuthMethodId", + "x-enum-keys": [ + "email-password", + "magic-url", + "email-otp", + "anonymous", + "invites", + "jwt", + "phone" + ] }, "in": "path" } @@ -31871,7 +32991,106 @@ "apps.write", "usage.read" ], - "x-enum-name": "ProjectKeyScopes" + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "rules.read", + "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "dedicatedDatabases.execute", + "domains.read", + "domains.write", + "events.read", + "apps.read", + "apps.write", + "usage.read" + ] } }, "expire": { @@ -32052,7 +33271,106 @@ "apps.write", "usage.read" ], - "x-enum-name": "ProjectKeyScopes" + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "rules.read", + "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "dedicatedDatabases.execute", + "domains.read", + "domains.write", + "events.read", + "apps.read", + "apps.write", + "usage.read" + ] } }, "duration": { @@ -32308,7 +33626,106 @@ "apps.write", "usage.read" ], - "x-enum-name": "ProjectKeyScopes" + "x-enum-name": "ProjectKeyScopes", + "x-enum-keys": [ + "project.read", + "project.write", + "keys.read", + "keys.write", + "platforms.read", + "platforms.write", + "mocks.read", + "mocks.write", + "policies.read", + "policies.write", + "project.policies.read", + "project.policies.write", + "templates.read", + "templates.write", + "oauth2.read", + "oauth2.write", + "users.read", + "users.write", + "sessions.read", + "sessions.write", + "teams.read", + "teams.write", + "databases.read", + "databases.write", + "tables.read", + "tables.write", + "columns.read", + "columns.write", + "indexes.read", + "indexes.write", + "rows.read", + "rows.write", + "collections.read", + "collections.write", + "attributes.read", + "attributes.write", + "documents.read", + "documents.write", + "buckets.read", + "buckets.write", + "files.read", + "files.write", + "tokens.read", + "tokens.write", + "functions.read", + "functions.write", + "executions.read", + "executions.write", + "execution.read", + "execution.write", + "sites.read", + "sites.write", + "log.read", + "log.write", + "providers.read", + "providers.write", + "topics.read", + "topics.write", + "subscribers.read", + "subscribers.write", + "targets.read", + "targets.write", + "messages.read", + "messages.write", + "rules.read", + "rules.write", + "webhooks.read", + "webhooks.write", + "locale.read", + "avatars.read", + "health.read", + "assistant.read", + "migrations.read", + "migrations.write", + "schedules.read", + "schedules.write", + "vcs.read", + "vcs.write", + "insights.read", + "insights.write", + "reports.read", + "reports.write", + "presences.read", + "presences.write", + "backups.policies.read", + "backups.policies.write", + "archives.read", + "archives.write", + "restorations.read", + "restorations.write", + "dedicatedDatabases.execute", + "domains.read", + "domains.write", + "events.read", + "apps.read", + "apps.write", + "usage.read" + ] } }, "expire": { @@ -34568,7 +35985,12 @@ "consent", "select_account" ], - "x-enum-name": "ProjectOAuth2GooglePrompt" + "x-enum-name": "ProjectOAuth2GooglePrompt", + "x-enum-keys": [ + "none", + "consent", + "select_account" + ] }, "x-nullable": true }, @@ -36729,7 +38151,52 @@ "zoho", "zoom" ], - "x-enum-name": "ProjectOAuthProviderId" + "x-enum-name": "ProjectOAuthProviderId", + "x-enum-keys": [ + "amazon", + "apple", + "auth0", + "authentik", + "autodesk", + "bitbucket", + "bitly", + "box", + "dailymotion", + "discord", + "disqus", + "dropbox", + "etsy", + "facebook", + "figma", + "fusionauth", + "github", + "gitlab", + "google", + "keycloak", + "kick", + "linkedin", + "microsoft", + "notion", + "oidc", + "okta", + "paypal", + "paypalSandbox", + "podio", + "salesforce", + "slack", + "spotify", + "stripe", + "tradeshift", + "tradeshiftBox", + "twitch", + "wordpress", + "x", + "yahoo", + "yammer", + "yandex", + "zoho", + "zoom" + ] }, "in": "path" } @@ -39002,7 +40469,22 @@ "deny-disposable-email", "deny-free-email" ], - "x-enum-name": "ProjectPolicyId" + "x-enum-name": "ProjectPolicyId", + "x-enum-keys": [ + "password-dictionary", + "password-history", + "password-strength", + "password-personal-data", + "session-alert", + "session-duration", + "session-invalidation", + "session-limit", + "user-limit", + "membership-privacy", + "deny-aliased-email", + "deny-disposable-email", + "deny-free-email" + ] }, "in": "path" } @@ -39070,7 +40552,12 @@ "graphql", "websocket" ], - "x-enum-name": "ProjectProtocolId" + "x-enum-name": "ProjectProtocolId", + "x-enum-keys": [ + "rest", + "graphql", + "websocket" + ] }, "in": "path" } @@ -39172,7 +40659,27 @@ "messaging", "advisor" ], - "x-enum-name": "ProjectServiceId" + "x-enum-name": "ProjectServiceId", + "x-enum-keys": [ + "account", + "avatars", + "databases", + "tablesdb", + "locale", + "health", + "project", + "storage", + "teams", + "users", + "vcs", + "sites", + "functions", + "proxy", + "graphql", + "migrations", + "messaging", + "advisor" + ] }, "in": "path" } @@ -39313,6 +40820,10 @@ "ssl" ], "x-enum-name": "ProjectSMTPSecure", + "x-enum-keys": [ + "tls", + "ssl" + ], "x-nullable": true }, "enabled": { @@ -39534,7 +41045,16 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "ProjectEmailTemplateId" + "x-enum-name": "ProjectEmailTemplateId", + "x-enum-keys": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ] }, "locale": { "type": "string", @@ -39673,7 +41193,140 @@ "zh-tw", "zu" ], - "x-enum-name": "ProjectEmailTemplateLocale" + "x-enum-name": "ProjectEmailTemplateLocale", + "x-enum-keys": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ] }, "subject": { "type": "string", @@ -39788,7 +41441,16 @@ "sessionAlert", "otpSession" ], - "x-enum-name": "ProjectEmailTemplateId" + "x-enum-name": "ProjectEmailTemplateId", + "x-enum-keys": [ + "verification", + "magicSession", + "recovery", + "invitation", + "mfaChallenge", + "sessionAlert", + "otpSession" + ] }, "in": "path" }, @@ -39932,7 +41594,140 @@ "zh-tw", "zu" ], - "x-enum-name": "ProjectEmailTemplateLocale" + "x-enum-name": "ProjectEmailTemplateLocale", + "x-enum-keys": [ + "af", + "ar-ae", + "ar-bh", + "ar-dz", + "ar-eg", + "ar-iq", + "ar-jo", + "ar-kw", + "ar-lb", + "ar-ly", + "ar-ma", + "ar-om", + "ar-qa", + "ar-sa", + "ar-sy", + "ar-tn", + "ar-ye", + "as", + "az", + "be", + "bg", + "bh", + "bn", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "de-at", + "de-ch", + "de-li", + "de-lu", + "el", + "en", + "en-au", + "en-bz", + "en-ca", + "en-gb", + "en-ie", + "en-jm", + "en-nz", + "en-tt", + "en-us", + "en-za", + "eo", + "es", + "es-ar", + "es-bo", + "es-cl", + "es-co", + "es-cr", + "es-do", + "es-ec", + "es-gt", + "es-hn", + "es-mx", + "es-ni", + "es-pa", + "es-pe", + "es-pr", + "es-py", + "es-sv", + "es-uy", + "es-ve", + "et", + "eu", + "fa", + "fi", + "fo", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "fr-lu", + "ga", + "gd", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "it-ch", + "ja", + "ji", + "ko", + "ku", + "lt", + "lv", + "mk", + "ml", + "ms", + "mt", + "nb", + "ne", + "nl", + "nl-be", + "nn", + "no", + "pa", + "pl", + "pt", + "pt-br", + "rm", + "ro", + "ro-md", + "ru", + "ru-md", + "sb", + "sk", + "sl", + "sq", + "sr", + "sv", + "sv-fi", + "th", + "tn", + "tr", + "ts", + "ua", + "ur", + "ve", + "vi", + "xh", + "zh-cn", + "zh-hk", + "zh-sg", + "zh-tw", + "zu" + ] }, "in": "query" } @@ -41434,7 +43229,24 @@ "vite", "other" ], - "x-enum-name": "Framework" + "x-enum-name": "Framework", + "x-enum-keys": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ] }, "enabled": { "type": "boolean", @@ -41579,7 +43391,103 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "BuildRuntime" + "x-enum-name": "BuildRuntime", + "x-enum-keys": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dart-3.12", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41", + "flutter-3.44" + ] }, "adapter": { "type": "string", @@ -41589,7 +43497,11 @@ "static", "ssr" ], - "x-enum-name": "Adapter" + "x-enum-name": "Adapter", + "x-enum-keys": [ + "static", + "ssr" + ] }, "installationId": { "type": "string", @@ -41929,7 +43841,24 @@ "vite", "other" ], - "x-enum-name": "Framework" + "x-enum-name": "Framework", + "x-enum-keys": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ] }, "enabled": { "type": "boolean", @@ -42074,7 +44003,103 @@ "flutter-3.41", "flutter-3.44" ], - "x-enum-name": "BuildRuntime" + "x-enum-name": "BuildRuntime", + "x-enum-keys": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.21", + "deno-1.24", + "deno-1.35", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dart-3.11", + "dart-3.12", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "rust-1.83", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "flutter-3.41", + "flutter-3.44" + ] }, "adapter": { "type": "string", @@ -42084,7 +44109,11 @@ "static", "ssr" ], - "x-enum-name": "Adapter" + "x-enum-name": "Adapter", + "x-enum-keys": [ + "static", + "ssr" + ] }, "fallbackFile": { "type": "string", @@ -42676,7 +44705,12 @@ "commit", "tag" ], - "x-enum-name": "TemplateReferenceType" + "x-enum-name": "TemplateReferenceType", + "x-enum-keys": [ + "branch", + "commit", + "tag" + ] }, "reference": { "type": "string", @@ -42778,7 +44812,12 @@ "commit", "tag" ], - "x-enum-name": "VCSReferenceType" + "x-enum-name": "VCSReferenceType", + "x-enum-keys": [ + "branch", + "commit", + "tag" + ] }, "reference": { "type": "string", @@ -42947,7 +44986,15 @@ "description": "Get a site 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.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "*\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -42963,7 +45010,6 @@ "scope": "sites.read", "platforms": [ "console", - "server", "server" ], "packaging": false, @@ -43015,6 +45061,10 @@ "output" ], "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [ + "source", + "output" + ], "default": "source" }, "in": "query" @@ -43280,6 +45330,9 @@ ], "packaging": false, "public": true, + "produces": [ + "application\/json" + ], "auth": { "Project": [], "Key": [] @@ -43928,7 +45981,223 @@ }, "compression": { "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "default": "none", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": "Compression", + "x-enum-keys": [ + "none", + "gzip", + "zstd" + ] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "default": true, + "x-example": false + } + }, + "required": [ + "bucketId", + "name" + ] + } + } + } + } + } + }, + "\/storage\/buckets\/{bucketId}": { + "get": { + "summary": "Get bucket", + "operationId": "storageGetBucket", + "tags": [ + "storage" + ], + "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", + "responses": { + "200": { + "description": "Bucket", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/bucket" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getBucket", + "group": "buckets", + "cookies": false, + "type": "", + "demo": "storage\/get-bucket.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "buckets.read", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Bucket unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update bucket", + "operationId": "storageUpdateBucket", + "tags": [ + "storage" + ], + "description": "Update a storage bucket by its unique ID.", + "responses": { + "200": { + "description": "Bucket", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/bucket" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateBucket", + "group": "buckets", + "cookies": false, + "type": "", + "demo": "storage\/update-bucket.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "buckets.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Bucket unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Bucket name", + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "default": true, + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 0B.", + "default": {}, + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", "default": "none", "x-example": "none", "enum": [ @@ -43936,218 +46205,12 @@ "gzip", "zstd" ], - "x-enum-name": "Compression" - }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "transformations": { - "type": "boolean", - "description": "Are image transformations enabled?", - "default": true, - "x-example": false - } - }, - "required": [ - "bucketId", - "name" - ] - } - } - } - } - } - }, - "\/storage\/buckets\/{bucketId}": { - "get": { - "summary": "Get bucket", - "operationId": "storageGetBucket", - "tags": [ - "storage" - ], - "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", - "responses": { - "200": { - "description": "Bucket", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/bucket" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getBucket", - "group": "buckets", - "cookies": false, - "type": "", - "demo": "storage\/get-bucket.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "put": { - "summary": "Update bucket", - "operationId": "storageUpdateBucket", - "tags": [ - "storage" - ], - "description": "Update a storage bucket by its unique ID.", - "responses": { - "200": { - "description": "Bucket", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/bucket" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateBucket", - "group": "buckets", - "cookies": false, - "type": "", - "demo": "storage\/update-bucket.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Bucket name", - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "default": true, - "x-example": false - }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 0B.", - "default": {}, - "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "default": "none", - "x-example": "none", - "enum": [ + "x-enum-name": "Compression", + "x-enum-keys": [ "none", "gzip", "zstd" - ], - "x-enum-name": "Compression" + ] }, "encryption": { "type": "boolean", @@ -44265,7 +46328,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -44365,7 +46427,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -44471,7 +46532,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -44546,7 +46606,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -44639,7 +46698,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -44692,7 +46750,15 @@ "description": "Get a file 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.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "*\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -44709,7 +46775,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -44775,7 +46840,15 @@ "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", "responses": { "200": { - "description": "Image" + "description": "Image", + "content": { + "image\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -44792,7 +46865,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -44877,6 +46949,17 @@ "bottom-right" ], "x-enum-name": "ImageGravity", + "x-enum-keys": [ + "center", + "top-left", + "top", + "top-right", + "left", + "right", + "bottom-left", + "bottom", + "bottom-right" + ], "default": "center" }, "in": "query" @@ -44977,7 +47060,16 @@ "avif", "gif" ], - "x-enum-name": "ImageFormat" + "x-enum-name": "ImageFormat", + "x-enum-keys": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ] }, "in": "query" }, @@ -45005,7 +47097,15 @@ "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", "responses": { "200": { - "description": "File" + "description": "File", + "content": { + "*\/*": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } }, "deprecated": false, @@ -45022,7 +47122,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -45295,8 +47394,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -45366,8 +47464,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -45442,8 +47539,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -45510,8 +47606,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -45594,8 +47689,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -45664,8 +47758,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -48592,11 +50685,11 @@ "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "array", + "items": { + "type": "number", + "format": "double" + } }, "x-nullable": true } @@ -48712,11 +50805,11 @@ "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "array", + "items": { + "type": "number", + "format": "double" + } }, "x-nullable": true }, @@ -49313,11 +51406,8 @@ "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", "x-example": "[1, 2]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "number", + "format": "double" }, "x-nullable": true } @@ -49433,11 +51523,8 @@ "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", "x-example": "[1, 2]", "items": { - "oneOf": [ - { - "type": "array" - } - ] + "type": "number", + "format": "double" }, "x-nullable": true }, @@ -49554,11 +51641,14 @@ "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "items": { - "oneOf": [ - { - "type": "array" + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - ] + } }, "x-nullable": true } @@ -49674,11 +51764,14 @@ "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "items": { - "oneOf": [ - { - "type": "array" + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" } - ] + } }, "x-nullable": true }, @@ -49795,7 +51888,13 @@ "manyToMany", "oneToMany" ], - "x-enum-name": "RelationshipType" + "x-enum-name": "RelationshipType", + "x-enum-keys": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ] }, "twoWay": { "type": "boolean", @@ -49825,7 +51924,12 @@ "restrict", "setNull" ], - "x-enum-name": "RelationMutate" + "x-enum-name": "RelationMutate", + "x-enum-keys": [ + "cascade", + "restrict", + "setNull" + ] } }, "required": [ @@ -51178,6 +53282,11 @@ "setNull" ], "x-enum-name": "RelationMutate", + "x-enum-keys": [ + "cascade", + "restrict", + "setNull" + ], "x-nullable": true }, "newKey": { @@ -51388,7 +53497,13 @@ "unique", "spatial" ], - "x-enum-name": "TablesDBIndexType" + "x-enum-name": "TablesDBIndexType", + "x-enum-keys": [ + "key", + "fulltext", + "unique", + "spatial" + ] }, "columns": { "type": "array", @@ -51409,7 +53524,11 @@ "asc", "desc" ], - "x-enum-name": "OrderBy" + "x-enum-name": "OrderBy", + "x-enum-keys": [ + "asc", + "desc" + ] } }, "lengths": { @@ -51633,7 +53752,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -51757,7 +53875,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -51879,7 +53996,7 @@ "data": { "type": "object", "description": "Row data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, "permissions": { @@ -52007,249 +54124,246 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "rows": { + "type": "array", + "description": "Array of row data as JSON objects. May contain partial rows.", + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + }, + "required": [ + "rows" + ] + } + } + } + } + }, + "patch": { + "summary": "Update rows", + "operationId": "tablesDBUpdateRows", + "tags": [ + "tablesDB" + ], + "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateRows", + "group": "rows", + "cookies": false, + "type": "", + "demo": "tablesdb\/update-rows.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Row data as JSON object. Include only column and value pairs to be updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "queries": { + "type": "array", + "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.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete rows", + "operationId": "tablesDBDeleteRows", + "tags": [ + "tablesDB" + ], + "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", + "responses": { + "200": { + "description": "Rows List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/rowList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteRows", + "group": "rows", + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-rows.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": [ + "rows.write", + "documents.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "rows": { - "type": "array", - "description": "Array of row data as JSON objects. May contain partial rows.", - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - }, - "required": [ - "rows" - ] - } - } - } - } - }, - "patch": { - "summary": "Update rows", - "operationId": "tablesDBUpdateRows", - "tags": [ - "tablesDB" - ], - "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.", - "responses": { - "200": { - "description": "Rows List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/rowList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateRows", - "group": "rows", - "cookies": false, - "type": "", - "demo": "tablesdb\/update-rows.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": [ - "rows.write", - "documents.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Row data as JSON object. Include only column and value pairs to be updated.", - "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete rows", - "operationId": "tablesDBDeleteRows", - "tags": [ - "tablesDB" - ], - "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.", - "responses": { - "200": { - "description": "Rows List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/rowList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteRows", - "group": "rows", - "cookies": false, - "type": "", - "demo": "tablesdb\/delete-rows.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": [ - "rows.write", - "documents.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "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.", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } + "in": "query" } - } + ] } }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": { @@ -52289,7 +54403,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -52400,7 +54513,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -52493,7 +54605,7 @@ "data": { "type": "object", "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "permissions": { @@ -52553,7 +54665,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -52613,7 +54724,7 @@ "data": { "type": "object", "description": "Row data as JSON object. Include only columns and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, "permissions": { @@ -52666,7 +54777,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -52715,25 +54825,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": { @@ -52773,8 +54876,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -52903,8 +55005,7 @@ "platforms": [ "client", "server", - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -53030,7 +55131,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -53120,7 +55220,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -53214,7 +55313,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -53279,7 +55377,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -53356,7 +55453,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -53423,7 +55519,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -53523,7 +55618,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -53645,7 +55739,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -53720,7 +55813,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -53810,7 +55902,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -54088,6 +56179,7 @@ "prefs": { "type": "object", "description": "Prefs key-value JSON object.", + "default": {}, "x-example": "{}" } }, @@ -55661,7 +57753,20 @@ "sha3-384", "sha3-512" ], - "x-enum-name": "PasswordHash" + "x-enum-name": "PasswordHash", + "x-enum-keys": [ + "sha1", + "sha224", + "sha256", + "sha384", + "sha512\/224", + "sha512\/256", + "sha512", + "sha3-224", + "sha3-256", + "sha3-384", + "sha3-512" + ] }, "name": { "type": "string", @@ -56587,7 +58692,10 @@ "enum": [ "totp" ], - "x-enum-name": "AuthenticatorType" + "x-enum-name": "AuthenticatorType", + "x-enum-keys": [ + "totp" + ] }, "in": "path" } @@ -57453,6 +59561,7 @@ "prefs": { "type": "object", "description": "Prefs key-value JSON object.", + "default": {}, "x-example": "{}" } }, @@ -57986,7 +60095,12 @@ "sms", "push" ], - "x-enum-name": "MessagingProviderType" + "x-enum-name": "MessagingProviderType", + "x-enum-keys": [ + "email", + "sms", + "push" + ] }, "identifier": { "type": "string", @@ -58708,7 +60822,6 @@ "scope": "documents.write", "platforms": [ "console", - "server", "server" ], "packaging": false, @@ -58778,7 +60891,13 @@ "all-minilm", "bge-small" ], - "x-enum-name": "EmbeddingModel" + "x-enum-name": "EmbeddingModel", + "x-enum-keys": [ + "nomic-embed-text", + "embedding-gemma", + "all-minilm", + "bge-small" + ] } }, "required": [ @@ -58824,8 +60943,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -58892,8 +61010,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -58965,8 +61082,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -59030,8 +61146,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -59111,8 +61226,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -59178,8 +61292,7 @@ "platforms": [ "console", "server", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -59935,7 +62048,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -60056,7 +62168,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -60176,7 +62287,7 @@ "data": { "type": "object", "description": "Document data as JSON object.", - "default": {}, + "default": [], "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" }, "permissions": { @@ -60415,7 +62526,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{}" }, "queries": { @@ -60506,33 +62617,31 @@ "x-example": "" }, "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } + ] } }, "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { @@ -60569,7 +62678,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -60677,7 +62785,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -60773,7 +62880,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -60828,7 +62935,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -60888,7 +62994,7 @@ "data": { "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", - "default": {}, + "default": [], "x-example": "{}" }, "permissions": { @@ -60936,7 +63042,6 @@ "platforms": [ "console", "client", - "server", "server" ], "packaging": false, @@ -60985,24 +63090,18 @@ "x-example": "" }, "in": "path" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } - } - } - } + ] } }, "\/vectorsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { @@ -61194,7 +63293,15 @@ "key", "unique" ], - "x-enum-name": "VectorsDBIndexType" + "x-enum-name": "VectorsDBIndexType", + "x-enum-keys": [ + "hnsw_euclidean", + "hnsw_dot", + "hnsw_cosine", + "object", + "key", + "unique" + ] }, "attributes": { "type": "array", @@ -61215,7 +63322,11 @@ "asc", "desc" ], - "x-enum-name": "OrderBy" + "x-enum-name": "OrderBy", + "x-enum-keys": [ + "asc", + "desc" + ] } }, "lengths": { @@ -61996,44 +64107,6 @@ "additionalProperties": true, "example": [] }, - "error": { - "description": "Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Error message.", - "x-example": "Not found" - }, - "code": { - "type": "string", - "description": "Error code.", - "x-example": "404" - }, - "type": { - "type": "string", - "description": "Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes", - "x-example": "not_found" - }, - "version": { - "type": "string", - "description": "Server version number.", - "x-example": "1.0" - } - }, - "required": [ - "message", - "code", - "type", - "version" - ], - "example": { - "message": "Not found", - "code": "404", - "type": "not_found", - "version": "1.0" - } - }, "rowList": { "description": "Rows List", "type": "object", @@ -65103,6 +67176,10 @@ 0, 0 ], + "items": { + "type": "number", + "format": "double" + }, "nullable": true } }, @@ -65196,6 +67273,13 @@ 1 ] ], + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, "nullable": true } }, @@ -65307,6 +67391,16 @@ ] ] ], + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + }, "nullable": true } }, @@ -67509,6 +69603,10 @@ 0, 0 ], + "items": { + "type": "number", + "format": "double" + }, "nullable": true } }, @@ -67602,6 +69700,13 @@ 1 ] ], + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, "nullable": true } }, @@ -67713,6 +69818,16 @@ ] ] ], + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + }, "nullable": true } }, @@ -68503,11 +70618,11 @@ }, "metadata": { "type": "object", + "additionalProperties": true, "description": "Presence metadata.", "x-example": { "key": "value" - }, - "nullable": true + } } }, "required": [ @@ -68738,43 +70853,45 @@ "type": "object", "description": "Password hashing algorithm configuration.", "x-example": {}, - "items": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/algoArgon2" - }, - { - "$ref": "#\/components\/schemas\/algoScrypt" - }, - { - "$ref": "#\/components\/schemas\/algoScryptModified" - }, - { - "$ref": "#\/components\/schemas\/algoBcrypt" - }, - { - "$ref": "#\/components\/schemas\/algoPhpass" - }, - { - "$ref": "#\/components\/schemas\/algoSha" - }, - { - "$ref": "#\/components\/schemas\/algoMd5" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "argon2": "#\/components\/schemas\/algoArgon2", - "scrypt": "#\/components\/schemas\/algoScrypt", - "scryptMod": "#\/components\/schemas\/algoScryptModified", - "bcrypt": "#\/components\/schemas\/algoBcrypt", - "phpass": "#\/components\/schemas\/algoPhpass", - "sha": "#\/components\/schemas\/algoSha", - "md5": "#\/components\/schemas\/algoMd5" + "allOf": [ + { + "oneOf": [ + { + "$ref": "#\/components\/schemas\/algoArgon2" + }, + { + "$ref": "#\/components\/schemas\/algoScrypt" + }, + { + "$ref": "#\/components\/schemas\/algoScryptModified" + }, + { + "$ref": "#\/components\/schemas\/algoBcrypt" + }, + { + "$ref": "#\/components\/schemas\/algoPhpass" + }, + { + "$ref": "#\/components\/schemas\/algoSha" + }, + { + "$ref": "#\/components\/schemas\/algoMd5" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "argon2": "#\/components\/schemas\/algoArgon2", + "scrypt": "#\/components\/schemas\/algoScrypt", + "scryptMod": "#\/components\/schemas\/algoScryptModified", + "bcrypt": "#\/components\/schemas\/algoBcrypt", + "phpass": "#\/components\/schemas\/algoPhpass", + "sha": "#\/components\/schemas\/algoSha", + "md5": "#\/components\/schemas\/algoMd5" + } } } - }, + ], "nullable": true }, "registration": { @@ -68864,9 +70981,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "$ref": "#\/components\/schemas\/preferences" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/preferences" + } + ] }, "targets": { "type": "array", @@ -69945,9 +72064,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "$ref": "#\/components\/schemas\/preferences" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/preferences" + } + ] } }, "required": [ @@ -71367,9 +73488,11 @@ "type": "object", "description": "Billing limits reached", "x-example": "", - "items": { - "$ref": "#\/components\/schemas\/billingLimits" - }, + "allOf": [ + { + "$ref": "#\/components\/schemas\/billingLimits" + } + ], "nullable": true }, "oAuth2ServerEnabled": { @@ -75371,6 +77494,7 @@ }, "credentials": { "type": "object", + "additionalProperties": true, "description": "Provider credentials.", "x-example": { "key": "123456789" @@ -75378,11 +77502,11 @@ }, "options": { "type": "object", + "additionalProperties": true, "description": "Provider options.", "x-example": { "from": "sender-email@mydomain" - }, - "nullable": true + } } }, "required": [ @@ -75496,6 +77620,7 @@ }, "data": { "type": "object", + "additionalProperties": true, "description": "Data of the message.", "x-example": { "subject": "Welcome to Appwrite", @@ -75716,9 +77841,11 @@ "identifier": "random-mail@email.org", "userId": "5e5ea5c16897e" }, - "items": { - "$ref": "#\/components\/schemas\/target" - } + "allOf": [ + { + "$ref": "#\/components\/schemas\/target" + } + ] }, "userId": { "type": "string", @@ -75999,6 +78126,7 @@ }, "params": { "type": "object", + "additionalProperties": true, "description": "Parameter map the client should pass to the service method when this CTA is triggered. Keys match the target API's parameter names (e.g. databaseId\/tableId\/columns for tablesDB, databaseId\/collectionId\/attributes for the legacy Databases API).", "x-example": { "databaseId": "main", @@ -76604,6 +78732,11 @@ "description": "Policy backup schedule in CRON format.", "x-example": "0 * * * *" }, + "type": { + "type": "string", + "description": "Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup).", + "x-example": "full" + }, "enabled": { "type": "boolean", "description": "Is this policy enabled.", @@ -76619,6 +78752,7 @@ "resources", "retention", "schedule", + "type", "enabled" ], "example": { @@ -76632,6 +78766,7 @@ "resourceType": "database", "retention": 7, "schedule": "0 * * * *", + "type": "full", "enabled": true } }, diff --git a/specs/1.9.x/swagger2-1.9.x-client.json b/specs/1.9.x/swagger2-1.9.x-client.json index 57fbda56..0d9a0653 100644 --- a/specs/1.9.x/swagger2-1.9.x-client.json +++ b/specs/1.9.x/swagger2-1.9.x-client.json @@ -8555,19 +8555,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -9928,18 +9921,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -14050,19 +14037,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -16440,18 +16420,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -16552,7 +16526,6 @@ "type": "array", "description": "List of rows.", "items": { - "type": "object", "$ref": "#\/definitions\/row" }, "x-example": "" @@ -16581,7 +16554,6 @@ "type": "array", "description": "List of documents.", "items": { - "type": "object", "$ref": "#\/definitions\/document" }, "x-example": "" @@ -16610,7 +16582,6 @@ "type": "array", "description": "List of presences.", "items": { - "type": "object", "$ref": "#\/definitions\/presence" }, "x-example": "" @@ -16639,7 +16610,6 @@ "type": "array", "description": "List of sessions.", "items": { - "type": "object", "$ref": "#\/definitions\/session" }, "x-example": "" @@ -16668,7 +16638,6 @@ "type": "array", "description": "List of identities.", "items": { - "type": "object", "$ref": "#\/definitions\/identity" }, "x-example": "" @@ -16697,7 +16666,6 @@ "type": "array", "description": "List of logs.", "items": { - "type": "object", "$ref": "#\/definitions\/log" }, "x-example": "" @@ -16726,7 +16694,6 @@ "type": "array", "description": "List of files.", "items": { - "type": "object", "$ref": "#\/definitions\/file" }, "x-example": "" @@ -16755,7 +16722,6 @@ "type": "array", "description": "List of teams.", "items": { - "type": "object", "$ref": "#\/definitions\/team" }, "x-example": "" @@ -16784,7 +16750,6 @@ "type": "array", "description": "List of memberships.", "items": { - "type": "object", "$ref": "#\/definitions\/membership" }, "x-example": "" @@ -16813,7 +16778,6 @@ "type": "array", "description": "List of executions.", "items": { - "type": "object", "$ref": "#\/definitions\/execution" }, "x-example": "" @@ -16842,7 +16806,6 @@ "type": "array", "description": "List of countries.", "items": { - "type": "object", "$ref": "#\/definitions\/country" }, "x-example": "" @@ -16871,7 +16834,6 @@ "type": "array", "description": "List of continents.", "items": { - "type": "object", "$ref": "#\/definitions\/continent" }, "x-example": "" @@ -16900,7 +16862,6 @@ "type": "array", "description": "List of languages.", "items": { - "type": "object", "$ref": "#\/definitions\/language" }, "x-example": "" @@ -16929,7 +16890,6 @@ "type": "array", "description": "List of currencies.", "items": { - "type": "object", "$ref": "#\/definitions\/currency" }, "x-example": "" @@ -16958,7 +16918,6 @@ "type": "array", "description": "List of phones.", "items": { - "type": "object", "$ref": "#\/definitions\/phone" }, "x-example": "" @@ -16987,7 +16946,6 @@ "type": "array", "description": "List of localeCodes.", "items": { - "type": "object", "$ref": "#\/definitions\/localeCode" }, "x-example": "" @@ -17016,7 +16974,6 @@ "type": "array", "description": "List of transactions.", "items": { - "type": "object", "$ref": "#\/definitions\/transaction" }, "x-example": "" @@ -17464,41 +17421,39 @@ "type": "object", "description": "Password hashing algorithm configuration.", "x-example": {}, - "items": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/algoArgon2" - }, - { - "$ref": "#\/definitions\/algoScrypt" - }, - { - "$ref": "#\/definitions\/algoScryptModified" - }, - { - "$ref": "#\/definitions\/algoBcrypt" - }, - { - "$ref": "#\/definitions\/algoPhpass" - }, - { - "$ref": "#\/definitions\/algoSha" - }, - { - "$ref": "#\/definitions\/algoMd5" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "argon2": "#\/definitions\/algoArgon2", - "scrypt": "#\/definitions\/algoScrypt", - "scryptMod": "#\/definitions\/algoScryptModified", - "bcrypt": "#\/definitions\/algoBcrypt", - "phpass": "#\/definitions\/algoPhpass", - "sha": "#\/definitions\/algoSha", - "md5": "#\/definitions\/algoMd5" - } + "x-oneOf": [ + { + "$ref": "#\/definitions\/algoArgon2" + }, + { + "$ref": "#\/definitions\/algoScrypt" + }, + { + "$ref": "#\/definitions\/algoScryptModified" + }, + { + "$ref": "#\/definitions\/algoBcrypt" + }, + { + "$ref": "#\/definitions\/algoPhpass" + }, + { + "$ref": "#\/definitions\/algoSha" + }, + { + "$ref": "#\/definitions\/algoMd5" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "argon2": "#\/definitions\/algoArgon2", + "scrypt": "#\/definitions\/algoScrypt", + "scryptMod": "#\/definitions\/algoScryptModified", + "bcrypt": "#\/definitions\/algoBcrypt", + "phpass": "#\/definitions\/algoPhpass", + "sha": "#\/definitions\/algoSha", + "md5": "#\/definitions\/algoMd5" } }, "x-nullable": true @@ -17590,16 +17545,16 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "type": "object", - "$ref": "#\/definitions\/preferences" - } + "allOf": [ + { + "$ref": "#\/definitions\/preferences" + } + ] }, "targets": { "type": "array", "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", "items": { - "type": "object", "$ref": "#\/definitions\/target" }, "x-example": [] @@ -18488,10 +18443,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "type": "object", - "$ref": "#\/definitions\/preferences" - } + "allOf": [ + { + "$ref": "#\/definitions\/preferences" + } + ] } }, "required": [ @@ -18711,7 +18667,6 @@ "type": "array", "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", "items": { - "type": "object", "$ref": "#\/definitions\/headers" }, "x-example": [ @@ -18735,7 +18690,6 @@ "type": "array", "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", "items": { - "type": "object", "$ref": "#\/definitions\/headers" }, "x-example": [ @@ -19228,10 +19182,11 @@ "identifier": "random-mail@email.org", "userId": "5e5ea5c16897e" }, - "items": { - "type": "object", - "$ref": "#\/definitions\/target" - } + "allOf": [ + { + "$ref": "#\/definitions\/target" + } + ] }, "userId": { "type": "string", @@ -19457,7 +19412,6 @@ "type": "array", "description": "List of application secrets.", "items": { - "type": "object", "$ref": "#\/definitions\/appSecret" }, "x-example": [] @@ -19823,7 +19777,6 @@ "type": "array", "description": "List of apps.", "items": { - "type": "object", "$ref": "#\/definitions\/app" }, "x-example": "" @@ -19852,7 +19805,6 @@ "type": "array", "description": "List of secrets.", "items": { - "type": "object", "$ref": "#\/definitions\/appSecret" }, "x-example": "" diff --git a/specs/1.9.x/swagger2-1.9.x-console.json b/specs/1.9.x/swagger2-1.9.x-console.json index b525d8fb..6d144a5a 100644 --- a/specs/1.9.x/swagger2-1.9.x-console.json +++ b/specs/1.9.x/swagger2-1.9.x-console.json @@ -10788,7 +10788,7 @@ "tags": [ "compute" ], - "description": " List scheduled backup policies for a dedicated database.", + "description": "List scheduled backup policies for a dedicated database.", "responses": { "200": { "description": "Backup policy list", @@ -10857,7 +10857,7 @@ "tags": [ "compute" ], - "description": " Create a scheduled backup policy for a dedicated database.", + "description": "Create a scheduled backup policy for a dedicated database.", "responses": { "201": { "description": "backup", @@ -18261,7 +18261,14 @@ "type": "array", "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } } }, "required": [ @@ -18366,7 +18373,14 @@ "type": "array", "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } }, "newKey": { "type": "string", @@ -18910,7 +18924,11 @@ "type": "array", "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.", "x-example": "[1, 2]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "number", + "format": "double" + } } }, "required": [ @@ -19015,7 +19033,11 @@ "type": "array", "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.", "x-example": "[1, 2]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "number", + "format": "double" + } }, "newKey": { "type": "string", @@ -19123,7 +19145,17 @@ "type": "array", "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } } }, "required": [ @@ -19228,7 +19260,17 @@ "type": "array", "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } }, "newKey": { "type": "string", @@ -21259,28 +21301,24 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } + "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.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -21729,19 +21767,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -24685,27 +24716,24 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } + "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.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -25127,18 +25155,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -36279,56 +36301,52 @@ }, "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "projectId": { - "type": "string", - "description": "Project ID", - "x-example": "" - }, - "resourceType": { - "type": "string", - "description": "Resource type to unblock", - "x-example": "projects", - "enum": [ - "projects", - "functions", - "sites", - "databases", - "buckets", - "providers", - "topics", - "subscribers", - "messages" - ], - "x-enum-name": "BlockResourceType", - "x-enum-keys": [ - "projects", - "functions", - "sites", - "databases", - "buckets", - "providers", - "topics", - "subscribers", - "messages" - ] - }, - "resourceId": { - "type": "string", - "description": "Optional resource ID (if omitted, all blocks of this type will be removed)", - "default": "", - "x-example": "" - } - }, - "required": [ - "projectId", - "resourceType" - ] - } + "name": "projectId", + "description": "Project ID", + "required": true, + "type": "string", + "x-example": "", + "in": "query" + }, + { + "name": "resourceType", + "description": "Resource type to unblock", + "required": true, + "type": "string", + "x-example": "projects", + "enum": [ + "projects", + "functions", + "sites", + "databases", + "buckets", + "providers", + "topics", + "subscribers", + "messages" + ], + "x-enum-name": "BlockResourceType", + "x-enum-keys": [ + "projects", + "functions", + "sites", + "databases", + "buckets", + "providers", + "topics", + "subscribers", + "messages" + ], + "in": "query" + }, + { + "name": "resourceId", + "description": "Optional resource ID (if omitted, all blocks of this type will be removed)", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -36423,99 +36441,111 @@ }, "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "region": { - "type": "string", - "description": "Target region.", - "x-example": "fra", - "enum": [ - "fra", - "nyc", - "syd", - "sfo", - "sgp", - "tor" - ], - "x-enum-name": "Region", - "x-enum-keys": [ - "fra", - "nyc", - "syd", - "sfo", - "sgp", - "tor" - ] - }, - "cache": { - "type": "string", - "description": "Cache target.", - "default": "cache", - "x-example": "cache", - "enum": [ - "cache", - "timelimit", - "locks", - "pubsub", - "queue", - "all" - ], - "x-enum-name": "CacheTarget", - "x-enum-keys": [ - "cache", - "timelimit", - "locks", - "pubsub", - "queue", - "all" - ] - }, - "all": { - "type": "boolean", - "description": "Clear the entire selected cache target.", - "default": false, - "x-example": false - }, - "database": { - "type": "string", - "description": "Database cache scope.", - "default": "console", - "x-example": "console", - "enum": [ - "console", - "project", - "logs" - ], - "x-enum-name": "CacheDatabase", - "x-enum-keys": [ - "console", - "project", - "logs" - ] - }, - "projectId": { - "type": "string", - "description": "Project ID for project or logs database cache.", - "default": "", - "x-example": "" - }, - "collectionId": { - "type": "string", - "description": "Collection ID.", - "default": "", - "x-example": "" - }, - "documentId": { - "type": "string", - "description": "Document ID.", - "default": "", - "x-example": "" - } - } - } + "name": "region", + "description": "Target region.", + "required": false, + "type": "string", + "x-example": "fra", + "enum": [ + "fra", + "nyc", + "syd", + "sfo", + "sgp", + "tor" + ], + "x-enum-name": "Region", + "x-enum-keys": [ + "fra", + "nyc", + "syd", + "sfo", + "sgp", + "tor" + ], + "in": "query" + }, + { + "name": "cache", + "description": "Cache target.", + "required": false, + "type": "string", + "x-example": "cache", + "enum": [ + "cache", + "timelimit", + "locks", + "pubsub", + "queue", + "all" + ], + "x-enum-name": "CacheTarget", + "x-enum-keys": [ + "cache", + "timelimit", + "locks", + "pubsub", + "queue", + "all" + ], + "default": "cache", + "in": "query" + }, + { + "name": "all", + "description": "Clear the entire selected cache target.", + "required": false, + "type": "boolean", + "x-example": false, + "default": false, + "in": "query" + }, + { + "name": "database", + "description": "Database cache scope.", + "required": false, + "type": "string", + "x-example": "console", + "enum": [ + "console", + "project", + "logs" + ], + "x-enum-name": "CacheDatabase", + "x-enum-keys": [ + "console", + "project", + "logs" + ], + "default": "console", + "in": "query" + }, + { + "name": "projectId", + "description": "Project ID for project or logs database cache.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } @@ -68033,7 +68063,14 @@ "type": "array", "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } } }, "required": [ @@ -68139,7 +68176,14 @@ "type": "array", "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } }, "newKey": { "type": "string", @@ -68704,7 +68748,11 @@ "type": "array", "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", "x-example": "[1, 2]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "number", + "format": "double" + } } }, "required": [ @@ -68810,7 +68858,11 @@ "type": "array", "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", "x-example": "[1, 2]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "number", + "format": "double" + } }, "newKey": { "type": "string", @@ -68919,7 +68971,17 @@ "type": "array", "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } } }, "required": [ @@ -69025,7 +69087,17 @@ "type": "array", "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } }, "newKey": { "type": "string", @@ -71547,28 +71619,24 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } + "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.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -72006,19 +72074,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -80876,27 +80937,24 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } + "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.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -81321,18 +81379,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -82509,7 +82561,6 @@ "type": "array", "description": "List of rows.", "items": { - "type": "object", "$ref": "#\/definitions\/row" }, "x-example": "" @@ -82538,7 +82589,6 @@ "type": "array", "description": "List of documents.", "items": { - "type": "object", "$ref": "#\/definitions\/document" }, "x-example": "" @@ -82567,7 +82617,6 @@ "type": "array", "description": "List of presences.", "items": { - "type": "object", "$ref": "#\/definitions\/presence" }, "x-example": "" @@ -82596,7 +82645,6 @@ "type": "array", "description": "List of tables.", "items": { - "type": "object", "$ref": "#\/definitions\/table" }, "x-example": "" @@ -82625,7 +82673,6 @@ "type": "array", "description": "List of collections.", "items": { - "type": "object", "$ref": "#\/definitions\/collection" }, "x-example": "" @@ -82654,7 +82701,6 @@ "type": "array", "description": "List of databases.", "items": { - "type": "object", "$ref": "#\/definitions\/database" }, "x-example": "" @@ -82683,7 +82729,6 @@ "type": "array", "description": "List of indexes.", "items": { - "type": "object", "$ref": "#\/definitions\/index" }, "x-example": "" @@ -82712,7 +82757,6 @@ "type": "array", "description": "List of indexes.", "items": { - "type": "object", "$ref": "#\/definitions\/columnIndex" }, "x-example": "" @@ -82741,7 +82785,6 @@ "type": "array", "description": "List of users.", "items": { - "type": "object", "$ref": "#\/definitions\/user" }, "x-example": "" @@ -82770,7 +82813,6 @@ "type": "array", "description": "List of sessions.", "items": { - "type": "object", "$ref": "#\/definitions\/session" }, "x-example": "" @@ -82799,7 +82841,6 @@ "type": "array", "description": "List of identities.", "items": { - "type": "object", "$ref": "#\/definitions\/identity" }, "x-example": "" @@ -82828,7 +82869,6 @@ "type": "array", "description": "List of logs.", "items": { - "type": "object", "$ref": "#\/definitions\/log" }, "x-example": "" @@ -82857,7 +82897,6 @@ "type": "array", "description": "List of files.", "items": { - "type": "object", "$ref": "#\/definitions\/file" }, "x-example": "" @@ -82886,7 +82925,6 @@ "type": "array", "description": "List of buckets.", "items": { - "type": "object", "$ref": "#\/definitions\/bucket" }, "x-example": "" @@ -82915,7 +82953,6 @@ "type": "array", "description": "List of tokens.", "items": { - "type": "object", "$ref": "#\/definitions\/resourceToken" }, "x-example": "" @@ -82944,7 +82981,6 @@ "type": "array", "description": "List of teams.", "items": { - "type": "object", "$ref": "#\/definitions\/team" }, "x-example": "" @@ -82973,7 +83009,6 @@ "type": "array", "description": "List of memberships.", "items": { - "type": "object", "$ref": "#\/definitions\/membership" }, "x-example": "" @@ -83002,7 +83037,6 @@ "type": "array", "description": "List of sites.", "items": { - "type": "object", "$ref": "#\/definitions\/site" }, "x-example": "" @@ -83031,7 +83065,6 @@ "type": "array", "description": "List of templates.", "items": { - "type": "object", "$ref": "#\/definitions\/templateSite" }, "x-example": "" @@ -83060,7 +83093,6 @@ "type": "array", "description": "List of functions.", "items": { - "type": "object", "$ref": "#\/definitions\/function" }, "x-example": "" @@ -83089,7 +83121,6 @@ "type": "array", "description": "List of templates.", "items": { - "type": "object", "$ref": "#\/definitions\/templateFunction" }, "x-example": "" @@ -83118,7 +83149,6 @@ "type": "array", "description": "List of installations.", "items": { - "type": "object", "$ref": "#\/definitions\/installation" }, "x-example": "" @@ -83147,7 +83177,6 @@ "type": "array", "description": "List of frameworkProviderRepositories.", "items": { - "type": "object", "$ref": "#\/definitions\/providerRepositoryFramework" }, "x-example": "" @@ -83183,7 +83212,6 @@ "type": "array", "description": "List of runtimeProviderRepositories.", "items": { - "type": "object", "$ref": "#\/definitions\/providerRepositoryRuntime" }, "x-example": "" @@ -83219,7 +83247,6 @@ "type": "array", "description": "List of branches.", "items": { - "type": "object", "$ref": "#\/definitions\/branch" }, "x-example": "" @@ -83248,7 +83275,6 @@ "type": "array", "description": "List of frameworks.", "items": { - "type": "object", "$ref": "#\/definitions\/framework" }, "x-example": "" @@ -83277,7 +83303,6 @@ "type": "array", "description": "List of runtimes.", "items": { - "type": "object", "$ref": "#\/definitions\/runtime" }, "x-example": "" @@ -83306,7 +83331,6 @@ "type": "array", "description": "List of deployments.", "items": { - "type": "object", "$ref": "#\/definitions\/deployment" }, "x-example": "" @@ -83335,7 +83359,6 @@ "type": "array", "description": "List of executions.", "items": { - "type": "object", "$ref": "#\/definitions\/execution" }, "x-example": "" @@ -83364,7 +83387,6 @@ "type": "array", "description": "List of projects.", "items": { - "type": "object", "$ref": "#\/definitions\/project" }, "x-example": "" @@ -83393,7 +83415,6 @@ "type": "array", "description": "List of webhooks.", "items": { - "type": "object", "$ref": "#\/definitions\/webhook" }, "x-example": "" @@ -83422,7 +83443,6 @@ "type": "array", "description": "List of keys.", "items": { - "type": "object", "$ref": "#\/definitions\/key" }, "x-example": "" @@ -83451,7 +83471,6 @@ "type": "array", "description": "List of devKeys.", "items": { - "type": "object", "$ref": "#\/definitions\/devKey" }, "x-example": "" @@ -83480,7 +83499,6 @@ "type": "array", "description": "List of countries.", "items": { - "type": "object", "$ref": "#\/definitions\/country" }, "x-example": "" @@ -83509,7 +83527,6 @@ "type": "array", "description": "List of continents.", "items": { - "type": "object", "$ref": "#\/definitions\/continent" }, "x-example": "" @@ -83538,7 +83555,6 @@ "type": "array", "description": "List of languages.", "items": { - "type": "object", "$ref": "#\/definitions\/language" }, "x-example": "" @@ -83567,7 +83583,6 @@ "type": "array", "description": "List of currencies.", "items": { - "type": "object", "$ref": "#\/definitions\/currency" }, "x-example": "" @@ -83596,7 +83611,6 @@ "type": "array", "description": "List of phones.", "items": { - "type": "object", "$ref": "#\/definitions\/phone" }, "x-example": "" @@ -83625,7 +83639,6 @@ "type": "array", "description": "List of variables.", "items": { - "type": "object", "$ref": "#\/definitions\/variable" }, "x-example": "" @@ -83654,7 +83667,6 @@ "type": "array", "description": "List of mockNumbers.", "items": { - "type": "object", "$ref": "#\/definitions\/mockNumber" }, "x-example": "" @@ -83769,7 +83781,6 @@ "type": "array", "description": "List of templates.", "items": { - "type": "object", "$ref": "#\/definitions\/emailTemplate" }, "x-example": "" @@ -83798,7 +83809,6 @@ "type": "array", "description": "List of statuses.", "items": { - "type": "object", "$ref": "#\/definitions\/healthStatus" }, "x-example": "" @@ -83827,7 +83837,6 @@ "type": "array", "description": "List of rules.", "items": { - "type": "object", "$ref": "#\/definitions\/proxyRule" }, "x-example": "" @@ -83856,7 +83865,6 @@ "type": "array", "description": "List of schedules.", "items": { - "type": "object", "$ref": "#\/definitions\/schedule" }, "x-example": "" @@ -83885,7 +83893,6 @@ "type": "array", "description": "List of localeCodes.", "items": { - "type": "object", "$ref": "#\/definitions\/localeCode" }, "x-example": "" @@ -83914,7 +83921,6 @@ "type": "array", "description": "List of providers.", "items": { - "type": "object", "$ref": "#\/definitions\/provider" }, "x-example": "" @@ -83943,7 +83949,6 @@ "type": "array", "description": "List of messages.", "items": { - "type": "object", "$ref": "#\/definitions\/message" }, "x-example": "" @@ -83972,7 +83977,6 @@ "type": "array", "description": "List of topics.", "items": { - "type": "object", "$ref": "#\/definitions\/topic" }, "x-example": "" @@ -84001,7 +84005,6 @@ "type": "array", "description": "List of subscribers.", "items": { - "type": "object", "$ref": "#\/definitions\/subscriber" }, "x-example": "" @@ -84030,7 +84033,6 @@ "type": "array", "description": "List of targets.", "items": { - "type": "object", "$ref": "#\/definitions\/target" }, "x-example": "" @@ -84059,7 +84061,6 @@ "type": "array", "description": "List of transactions.", "items": { - "type": "object", "$ref": "#\/definitions\/transaction" }, "x-example": "" @@ -84088,7 +84089,6 @@ "type": "array", "description": "List of migrations.", "items": { - "type": "object", "$ref": "#\/definitions\/migration" }, "x-example": "" @@ -84117,7 +84117,6 @@ "type": "array", "description": "List of specifications.", "items": { - "type": "object", "$ref": "#\/definitions\/specification" }, "x-example": "" @@ -84146,7 +84145,6 @@ "type": "array", "description": "List of contents.", "items": { - "type": "object", "$ref": "#\/definitions\/vcsContent" }, "x-example": "" @@ -84175,7 +84173,6 @@ "type": "array", "description": "List of collections.", "items": { - "type": "object", "$ref": "#\/definitions\/vectorsdbCollection" }, "x-example": "" @@ -84204,7 +84201,6 @@ "type": "array", "description": "List of embeddings.", "items": { - "type": "object", "$ref": "#\/definitions\/embedding" }, "x-example": "" @@ -84233,7 +84229,6 @@ "type": "array", "description": "List of insights.", "items": { - "type": "object", "$ref": "#\/definitions\/insight" }, "x-example": "" @@ -84262,7 +84257,6 @@ "type": "array", "description": "List of reports.", "items": { - "type": "object", "$ref": "#\/definitions\/report" }, "x-example": "" @@ -84321,7 +84315,6 @@ "type": "array", "description": "Database backup policies.", "items": { - "type": "object", "$ref": "#\/definitions\/backupPolicy" }, "x-example": {} @@ -84330,7 +84323,6 @@ "type": "array", "description": "Database backup archives.", "items": { - "type": "object", "$ref": "#\/definitions\/backupArchive" }, "x-example": {} @@ -84607,7 +84599,6 @@ "type": "array", "description": "Collection indexes.", "items": { - "type": "object", "$ref": "#\/definitions\/index" }, "x-example": {} @@ -85919,6 +85910,10 @@ 0, 0 ], + "items": { + "type": "number", + "format": "double" + }, "x-nullable": true } }, @@ -86012,6 +86007,13 @@ 1 ] ], + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, "x-nullable": true } }, @@ -86123,6 +86125,16 @@ ] ] ], + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + }, "x-nullable": true } }, @@ -86571,7 +86583,6 @@ "type": "array", "description": "Aggregated number of collections per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -86580,7 +86591,6 @@ "type": "array", "description": "Aggregated number of documents per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -86589,7 +86599,6 @@ "type": "array", "description": "Aggregated storage used in bytes per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -86598,7 +86607,6 @@ "type": "array", "description": "An array of aggregated number of database reads.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -86607,7 +86615,6 @@ "type": "array", "description": "An array of aggregated number of database writes.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -86715,7 +86722,6 @@ "type": "array", "description": "Collection indexes.", "items": { - "type": "object", "$ref": "#\/definitions\/index" }, "x-example": {} @@ -86977,7 +86983,6 @@ "type": "array", "description": "Aggregated number of databases per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -86986,7 +86991,6 @@ "type": "array", "description": "Aggregated number of collections per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -86995,7 +86999,6 @@ "type": "array", "description": "Aggregated number of documents per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -87004,7 +87007,6 @@ "type": "array", "description": "Aggregated storage in bytes per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -87013,7 +87015,6 @@ "type": "array", "description": "An array of aggregated number of database reads.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -87022,7 +87023,6 @@ "type": "array", "description": "An array of aggregated number of database writes.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -87102,7 +87102,6 @@ "type": "array", "description": "Aggregated number of collections per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -87111,7 +87110,6 @@ "type": "array", "description": "Aggregated number of documents per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -87120,7 +87118,6 @@ "type": "array", "description": "Aggregated storage used in bytes per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -87129,7 +87126,6 @@ "type": "array", "description": "An array of aggregated number of database reads.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -87138,7 +87134,6 @@ "type": "array", "description": "An array of aggregated number of database writes.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -87370,7 +87365,6 @@ "type": "array", "description": "Table indexes.", "items": { - "type": "object", "$ref": "#\/definitions\/columnIndex" }, "x-example": {} @@ -88682,6 +88676,10 @@ 0, 0 ], + "items": { + "type": "number", + "format": "double" + }, "x-nullable": true } }, @@ -88775,6 +88773,13 @@ 1 ] ], + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, "x-nullable": true } }, @@ -88886,6 +88891,16 @@ ] ] ], + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + }, "x-nullable": true } }, @@ -89911,41 +89926,39 @@ "type": "object", "description": "Password hashing algorithm configuration.", "x-example": {}, - "items": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/algoArgon2" - }, - { - "$ref": "#\/definitions\/algoScrypt" - }, - { - "$ref": "#\/definitions\/algoScryptModified" - }, - { - "$ref": "#\/definitions\/algoBcrypt" - }, - { - "$ref": "#\/definitions\/algoPhpass" - }, - { - "$ref": "#\/definitions\/algoSha" - }, - { - "$ref": "#\/definitions\/algoMd5" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "argon2": "#\/definitions\/algoArgon2", - "scrypt": "#\/definitions\/algoScrypt", - "scryptMod": "#\/definitions\/algoScryptModified", - "bcrypt": "#\/definitions\/algoBcrypt", - "phpass": "#\/definitions\/algoPhpass", - "sha": "#\/definitions\/algoSha", - "md5": "#\/definitions\/algoMd5" - } + "x-oneOf": [ + { + "$ref": "#\/definitions\/algoArgon2" + }, + { + "$ref": "#\/definitions\/algoScrypt" + }, + { + "$ref": "#\/definitions\/algoScryptModified" + }, + { + "$ref": "#\/definitions\/algoBcrypt" + }, + { + "$ref": "#\/definitions\/algoPhpass" + }, + { + "$ref": "#\/definitions\/algoSha" + }, + { + "$ref": "#\/definitions\/algoMd5" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "argon2": "#\/definitions\/algoArgon2", + "scrypt": "#\/definitions\/algoScrypt", + "scryptMod": "#\/definitions\/algoScryptModified", + "bcrypt": "#\/definitions\/algoBcrypt", + "phpass": "#\/definitions\/algoPhpass", + "sha": "#\/definitions\/algoSha", + "md5": "#\/definitions\/algoMd5" } }, "x-nullable": true @@ -90037,16 +90050,16 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "type": "object", - "$ref": "#\/definitions\/preferences" - } + "allOf": [ + { + "$ref": "#\/definitions\/preferences" + } + ] }, "targets": { "type": "array", "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", "items": { - "type": "object", "$ref": "#\/definitions\/target" }, "x-example": [] @@ -91120,10 +91133,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "type": "object", - "$ref": "#\/definitions\/preferences" - } + "allOf": [ + { + "$ref": "#\/definitions\/preferences" + } + ] } }, "required": [ @@ -91357,7 +91371,6 @@ "type": "array", "description": "Site variables.", "items": { - "type": "object", "$ref": "#\/definitions\/variable" }, "x-example": [] @@ -91586,7 +91599,6 @@ "type": "array", "description": "List of frameworks that can be used with this template.", "items": { - "type": "object", "$ref": "#\/definitions\/templateFramework" }, "x-example": [] @@ -91615,7 +91627,6 @@ "type": "array", "description": "Site variables.", "items": { - "type": "object", "$ref": "#\/definitions\/templateVariable" }, "x-example": [] @@ -91820,7 +91831,6 @@ "type": "array", "description": "Function variables.", "items": { - "type": "object", "$ref": "#\/definitions\/variable" }, "x-example": [] @@ -92055,7 +92065,6 @@ "type": "array", "description": "List of runtimes that can be used with this template.", "items": { - "type": "object", "$ref": "#\/definitions\/templateRuntime" }, "x-example": [] @@ -92089,7 +92098,6 @@ "type": "array", "description": "Function variables.", "items": { - "type": "object", "$ref": "#\/definitions\/templateVariable" }, "x-example": [] @@ -92588,7 +92596,6 @@ "type": "array", "description": "Environment variables found in .env files", "items": { - "type": "object", "$ref": "#\/definitions\/detectionVariable" }, "x-example": {}, @@ -92647,7 +92654,6 @@ "type": "array", "description": "Environment variables found in .env files", "items": { - "type": "object", "$ref": "#\/definitions\/detectionVariable" }, "x-example": {}, @@ -92859,7 +92865,6 @@ "type": "array", "description": "List of supported adapters.", "items": { - "type": "object", "$ref": "#\/definitions\/frameworkAdapter" }, "x-example": [ @@ -93230,7 +93235,6 @@ "type": "array", "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", "items": { - "type": "object", "$ref": "#\/definitions\/headers" }, "x-example": [ @@ -93254,7 +93258,6 @@ "type": "array", "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", "items": { - "type": "object", "$ref": "#\/definitions\/headers" }, "x-example": [ @@ -93374,7 +93377,6 @@ "type": "array", "description": "Deprecated since 1.9.5: List of dev keys.", "items": { - "type": "object", "$ref": "#\/definitions\/devKey" }, "x-example": {} @@ -93461,7 +93463,6 @@ "type": "array", "description": "List of auth methods.", "items": { - "type": "object", "$ref": "#\/definitions\/projectAuthMethod" }, "x-example": {} @@ -93470,7 +93471,6 @@ "type": "array", "description": "List of services.", "items": { - "type": "object", "$ref": "#\/definitions\/projectService" }, "x-example": {} @@ -93479,7 +93479,6 @@ "type": "array", "description": "List of protocols.", "items": { - "type": "object", "$ref": "#\/definitions\/projectProtocol" }, "x-example": {} @@ -93488,7 +93487,6 @@ "type": "array", "description": "Project blocks information", "items": { - "type": "object", "$ref": "#\/definitions\/block" }, "x-example": "" @@ -93502,10 +93500,11 @@ "type": "object", "description": "Billing limits reached", "x-example": "", - "items": { - "type": "object", - "$ref": "#\/definitions\/billingLimits" - }, + "allOf": [ + { + "$ref": "#\/definitions\/billingLimits" + } + ], "x-nullable": true }, "oAuth2ServerEnabled": { @@ -97211,7 +97210,6 @@ "type": "array", "description": "Aggregated number of databases per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97220,7 +97218,6 @@ "type": "array", "description": "Aggregated number of collections per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97229,7 +97226,6 @@ "type": "array", "description": "Aggregated number of tables per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97238,7 +97234,6 @@ "type": "array", "description": "Aggregated number of documents per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97247,7 +97242,6 @@ "type": "array", "description": "Aggregated number of rows per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97256,7 +97250,6 @@ "type": "array", "description": "An array of the aggregated number of databases storage in bytes per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97265,7 +97258,6 @@ "type": "array", "description": "An array of aggregated number of database reads.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97274,7 +97266,6 @@ "type": "array", "description": "An array of aggregated number of database writes.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97374,7 +97365,6 @@ "type": "array", "description": "Aggregated number of collections per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97383,7 +97373,6 @@ "type": "array", "description": "Aggregated number of tables per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97392,7 +97381,6 @@ "type": "array", "description": "Aggregated number of documents per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97401,7 +97389,6 @@ "type": "array", "description": "Aggregated number of rows per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97410,7 +97397,6 @@ "type": "array", "description": "Aggregated storage used in bytes per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97419,7 +97405,6 @@ "type": "array", "description": "An array of aggregated number of database reads.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97428,7 +97413,6 @@ "type": "array", "description": "An array of aggregated number of database writes.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97488,7 +97472,6 @@ "type": "array", "description": "Aggregated number of rows per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97524,7 +97507,6 @@ "type": "array", "description": "Aggregated number of documents per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97566,7 +97548,6 @@ "type": "array", "description": "Aggregated number of users per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97575,7 +97556,6 @@ "type": "array", "description": "Aggregated number of active sessions per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97615,7 +97595,6 @@ "type": "array", "description": "Aggregated number of online users per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97663,7 +97642,6 @@ "type": "array", "description": "Aggregated number of buckets per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97672,7 +97650,6 @@ "type": "array", "description": "Aggregated number of files per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97681,7 +97658,6 @@ "type": "array", "description": "Aggregated number of files storage (in bytes) per period .", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97731,7 +97707,6 @@ "type": "array", "description": "Aggregated number of bucket files per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97740,7 +97715,6 @@ "type": "array", "description": "Aggregated number of bucket storage files (in bytes) per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97749,7 +97723,6 @@ "type": "array", "description": "Aggregated number of files transformations per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97853,7 +97826,6 @@ "type": "array", "description": "Aggregated number of functions per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": 0 @@ -97862,7 +97834,6 @@ "type": "array", "description": "Aggregated number of functions deployment per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97871,7 +97842,6 @@ "type": "array", "description": "Aggregated number of functions deployment storage per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97892,7 +97862,6 @@ "type": "array", "description": "Aggregated number of functions build per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97901,7 +97870,6 @@ "type": "array", "description": "Aggregated sum of functions build storage per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97910,7 +97878,6 @@ "type": "array", "description": "Aggregated sum of functions build compute time per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97919,7 +97886,6 @@ "type": "array", "description": "Aggregated sum of functions build mbSeconds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97928,7 +97894,6 @@ "type": "array", "description": "Aggregated number of functions execution per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97937,7 +97902,6 @@ "type": "array", "description": "Aggregated number of functions execution compute time per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97946,7 +97910,6 @@ "type": "array", "description": "Aggregated number of functions mbSeconds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97955,7 +97918,6 @@ "type": "array", "description": "Aggregated number of successful function builds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -97964,7 +97926,6 @@ "type": "array", "description": "Aggregated number of failed function builds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98110,7 +98071,6 @@ "type": "array", "description": "Aggregated number of function deployments per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98119,7 +98079,6 @@ "type": "array", "description": "Aggregated number of function deployments storage per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98128,7 +98087,6 @@ "type": "array", "description": "Aggregated number of function builds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98137,7 +98095,6 @@ "type": "array", "description": "Aggregated sum of function builds storage per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98146,7 +98103,6 @@ "type": "array", "description": "Aggregated sum of function builds compute time per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98155,7 +98111,6 @@ "type": "array", "description": "Aggregated number of function builds mbSeconds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98164,7 +98119,6 @@ "type": "array", "description": "Aggregated number of function executions per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98173,7 +98127,6 @@ "type": "array", "description": "Aggregated number of function executions compute time per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98182,7 +98135,6 @@ "type": "array", "description": "Aggregated number of function mbSeconds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98191,7 +98143,6 @@ "type": "array", "description": "Aggregated number of successful builds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98200,7 +98151,6 @@ "type": "array", "description": "Aggregated number of failed builds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98278,7 +98228,6 @@ "type": "array", "description": "Aggregated number of sites per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98347,7 +98296,6 @@ "type": "array", "description": "Aggregated number of requests per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98362,7 +98310,6 @@ "type": "array", "description": "Aggregated number of inbound bandwidth per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98377,7 +98324,6 @@ "type": "array", "description": "Aggregated number of outbound bandwidth per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98386,7 +98332,6 @@ "type": "array", "description": "Aggregated number of sites deployment per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98395,7 +98340,6 @@ "type": "array", "description": "Aggregated number of sites deployment storage per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98416,7 +98360,6 @@ "type": "array", "description": "Aggregated number of sites build per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98425,7 +98368,6 @@ "type": "array", "description": "Aggregated sum of sites build storage per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98434,7 +98376,6 @@ "type": "array", "description": "Aggregated sum of sites build compute time per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98443,7 +98384,6 @@ "type": "array", "description": "Aggregated sum of sites build mbSeconds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98452,7 +98392,6 @@ "type": "array", "description": "Aggregated number of sites execution per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98461,7 +98400,6 @@ "type": "array", "description": "Aggregated number of sites execution compute time per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98470,7 +98408,6 @@ "type": "array", "description": "Aggregated number of sites mbSeconds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98479,7 +98416,6 @@ "type": "array", "description": "Aggregated number of successful site builds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98488,7 +98424,6 @@ "type": "array", "description": "Aggregated number of failed site builds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98646,7 +98581,6 @@ "type": "array", "description": "Aggregated number of function deployments per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98655,7 +98589,6 @@ "type": "array", "description": "Aggregated number of function deployments storage per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98664,7 +98597,6 @@ "type": "array", "description": "Aggregated number of function builds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98673,7 +98605,6 @@ "type": "array", "description": "Aggregated sum of function builds storage per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98682,7 +98613,6 @@ "type": "array", "description": "Aggregated sum of function builds compute time per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98691,7 +98621,6 @@ "type": "array", "description": "Aggregated number of function builds mbSeconds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98700,7 +98629,6 @@ "type": "array", "description": "Aggregated number of function executions per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98709,7 +98637,6 @@ "type": "array", "description": "Aggregated number of function executions compute time per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98718,7 +98645,6 @@ "type": "array", "description": "Aggregated number of function mbSeconds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98727,7 +98653,6 @@ "type": "array", "description": "Aggregated number of successful builds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98736,7 +98661,6 @@ "type": "array", "description": "Aggregated number of failed builds per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98751,7 +98675,6 @@ "type": "array", "description": "Aggregated number of requests per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98766,7 +98689,6 @@ "type": "array", "description": "Aggregated number of inbound bandwidth per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98781,7 +98703,6 @@ "type": "array", "description": "Aggregated number of outbound bandwidth per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98980,7 +98901,6 @@ "type": "array", "description": "Aggregated number of requests per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98989,7 +98909,6 @@ "type": "array", "description": "Aggregated number of consumed bandwidth per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -98998,7 +98917,6 @@ "type": "array", "description": "Aggregated number of users per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99007,7 +98925,6 @@ "type": "array", "description": "Aggregated number of executions per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99016,7 +98933,6 @@ "type": "array", "description": "Aggregated breakdown in totals of executions by functions.", "items": { - "type": "object", "$ref": "#\/definitions\/metricBreakdown" }, "x-example": [] @@ -99025,7 +98941,6 @@ "type": "array", "description": "Aggregated breakdown in totals of usage by buckets.", "items": { - "type": "object", "$ref": "#\/definitions\/metricBreakdown" }, "x-example": [] @@ -99034,7 +98949,6 @@ "type": "array", "description": "An array of the aggregated breakdown of storage usage by databases.", "items": { - "type": "object", "$ref": "#\/definitions\/metricBreakdown" }, "x-example": [] @@ -99043,7 +98957,6 @@ "type": "array", "description": "Aggregated breakdown in totals of execution mbSeconds by functions.", "items": { - "type": "object", "$ref": "#\/definitions\/metricBreakdown" }, "x-example": [] @@ -99052,7 +98965,6 @@ "type": "array", "description": "Aggregated breakdown in totals of build mbSeconds by functions.", "items": { - "type": "object", "$ref": "#\/definitions\/metricBreakdown" }, "x-example": [] @@ -99061,7 +98973,6 @@ "type": "array", "description": "Aggregated breakdown in totals of functions storage size (in bytes).", "items": { - "type": "object", "$ref": "#\/definitions\/metricBreakdown" }, "x-example": [] @@ -99082,7 +98993,6 @@ "type": "array", "description": "Aggregated breakdown in totals of phone auth by country.", "items": { - "type": "object", "$ref": "#\/definitions\/metricBreakdown" }, "x-example": [] @@ -99091,7 +99001,6 @@ "type": "array", "description": "Aggregated stats for database reads.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99100,7 +99009,6 @@ "type": "array", "description": "Aggregated stats for database writes.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99109,7 +99017,6 @@ "type": "array", "description": "An array of aggregated number of documentsdb database reads.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99118,7 +99025,6 @@ "type": "array", "description": "An array of aggregated number of documentsdb database writes.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99127,7 +99033,6 @@ "type": "array", "description": "An array of aggregated sum of documentsdb databases storage size (in bytes) per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99136,7 +99041,6 @@ "type": "array", "description": "An array of aggregated number of image transformations.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99187,7 +99091,6 @@ "type": "array", "description": "Aggregated VectorsDB databases per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99196,7 +99099,6 @@ "type": "array", "description": "Aggregated VectorsDB collections per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99205,7 +99107,6 @@ "type": "array", "description": "Aggregated VectorsDB documents per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99214,7 +99115,6 @@ "type": "array", "description": "Aggregated VectorsDB storage per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99223,7 +99123,6 @@ "type": "array", "description": "Aggregated VectorsDB reads per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99232,7 +99131,6 @@ "type": "array", "description": "Aggregated VectorsDB writes per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99241,79 +99139,86 @@ "type": "object", "description": "Aggregated number of text embedding calls per period.", "x-example": [], - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - } + "allOf": [ + { + "$ref": "#\/definitions\/metric" + } + ] }, "embeddingsTextTokens": { "type": "object", "description": "Aggregated number of tokens processed by text embeddings per period.", "x-example": [], - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - } + "allOf": [ + { + "$ref": "#\/definitions\/metric" + } + ] }, "embeddingsTextDuration": { "type": "object", "description": "Aggregated duration spent generating text embeddings per period.", "x-example": [], - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - } + "allOf": [ + { + "$ref": "#\/definitions\/metric" + } + ] }, "embeddingsTextErrors": { "type": "object", "description": "Aggregated number of errors while generating text embeddings per period.", "x-example": [], - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - } + "allOf": [ + { + "$ref": "#\/definitions\/metric" + } + ] }, "embeddingsTextTotal": { "type": "object", "description": "Total aggregated number of text embedding calls.", "x-example": 0, - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - } + "allOf": [ + { + "$ref": "#\/definitions\/metric" + } + ] }, "embeddingsTextTokensTotal": { "type": "object", "description": "Total aggregated number of tokens processed by text.", "x-example": 0, - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - } + "allOf": [ + { + "$ref": "#\/definitions\/metric" + } + ] }, "embeddingsTextDurationTotal": { "type": "object", "description": "Total aggregated duration spent generating text embeddings.", "x-example": 0, - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - } + "allOf": [ + { + "$ref": "#\/definitions\/metric" + } + ] }, "embeddingsTextErrorsTotal": { "type": "object", "description": "Total aggregated number of errors while generating text embeddings.", "x-example": 0, - "items": { - "type": "object", - "$ref": "#\/definitions\/metric" - } + "allOf": [ + { + "$ref": "#\/definitions\/metric" + } + ] }, "functionsExecutions": { "type": "array", "description": "Aggregated number of function executions per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99328,7 +99233,6 @@ "type": "array", "description": "Aggregated number of site executions per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99355,7 +99259,6 @@ "type": "array", "description": "An array of aggregated number of screenshots generated.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99370,7 +99273,6 @@ "type": "array", "description": "An array of aggregated number of Imagine credits in the given period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99403,7 +99305,6 @@ "type": "array", "description": "Aggregated number of open Realtime connections per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99412,7 +99313,6 @@ "type": "array", "description": "Aggregated number of Realtime messages sent to clients per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -99421,7 +99321,6 @@ "type": "array", "description": "Aggregated consumed Realtime bandwidth (in bytes) per period.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -100181,7 +100080,6 @@ "type": "array", "description": "List of parameters required to configure this OAuth2 provider.", "items": { - "type": "object", "$ref": "#\/definitions\/consoleOAuth2ProviderParameter" }, "x-example": "" @@ -100210,7 +100108,6 @@ "type": "array", "description": "List of OAuth2 providers, each with the parameters required to configure it.", "items": { - "type": "object", "$ref": "#\/definitions\/consoleOAuth2Provider" }, "x-example": "" @@ -100277,7 +100174,6 @@ "type": "array", "description": "List of key scopes, each with its ID and description.", "items": { - "type": "object", "$ref": "#\/definitions\/consoleKeyScope" }, "x-example": "" @@ -100806,10 +100702,11 @@ "identifier": "random-mail@email.org", "userId": "5e5ea5c16897e" }, - "items": { - "type": "object", - "$ref": "#\/definitions\/target" - } + "allOf": [ + { + "$ref": "#\/definitions\/target" + } + ] }, "userId": { "type": "string", @@ -101357,7 +101254,6 @@ "type": "array", "description": "List of call-to-action buttons attached to this insight.", "items": { - "type": "object", "$ref": "#\/definitions\/insightCTA" }, "x-example": [] @@ -101536,7 +101432,6 @@ "type": "array", "description": "Insights nested under this report.", "items": { - "type": "object", "$ref": "#\/definitions\/insight" }, "x-example": [] @@ -101971,7 +101866,6 @@ "type": "array", "description": "", "items": { - "type": "object", "$ref": "#\/definitions\/usageResources" }, "x-example": "" @@ -102160,7 +102054,6 @@ "type": "array", "description": "Aggregation project breakdown", "items": { - "type": "object", "$ref": "#\/definitions\/aggregationBreakdown" }, "x-example": [] @@ -102169,7 +102062,6 @@ "type": "array", "description": "Usage resources", "items": { - "type": "object", "$ref": "#\/definitions\/usageResources" }, "x-example": [] @@ -102464,7 +102356,6 @@ "type": "array", "description": "List of backups.", "items": { - "type": "object", "$ref": "#\/definitions\/dedicatedDatabaseBackup" }, "x-example": [] @@ -102883,19 +102774,21 @@ "type": "object", "description": "Additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/usageBillingPlan" - } + "allOf": [ + { + "$ref": "#\/definitions\/usageBillingPlan" + } + ] }, "addons": { "type": "object", "description": "Addons", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/billingPlanAddon" - } + "allOf": [ + { + "$ref": "#\/definitions\/billingPlanAddon" + } + ] }, "budgetCapEnabled": { "type": "boolean", @@ -102991,10 +102884,11 @@ "type": "object", "description": "Supported addons for this plan", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/billingPlanSupportedAddons" - } + "allOf": [ + { + "$ref": "#\/definitions\/billingPlanSupportedAddons" + } + ] }, "backupPolicies": { "type": "integer", @@ -103023,10 +102917,11 @@ "type": "object", "description": "Plan specific limits", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/billingPlanLimits" - }, + "allOf": [ + { + "$ref": "#\/definitions\/billingPlanLimits" + } + ], "x-nullable": true }, "group": { @@ -103043,10 +102938,11 @@ "type": "object", "description": "Details of the program this plan is a part of.", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/program" - }, + "allOf": [ + { + "$ref": "#\/definitions\/program" + } + ], "x-nullable": true } }, @@ -103189,19 +103085,21 @@ "type": "object", "description": "Addon seats", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/billingPlanAddonDetails" - } + "allOf": [ + { + "$ref": "#\/definitions\/billingPlanAddonDetails" + } + ] }, "projects": { "type": "object", "description": "Addon projects", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/billingPlanAddonDetails" - } + "allOf": [ + { + "$ref": "#\/definitions\/billingPlanAddonDetails" + } + ] } }, "required": [ @@ -103418,7 +103316,6 @@ "type": "array", "description": "List of deleted blocks", "items": { - "type": "object", "$ref": "#\/definitions\/block" }, "x-example": [] @@ -103537,7 +103434,6 @@ "type": "array", "description": "List of branches.", "items": { - "type": "object", "$ref": "#\/definitions\/dedicatedDatabaseBranch" }, "x-example": [] @@ -103608,7 +103504,6 @@ "type": "array", "description": "Campaign reviews", "items": { - "type": "object", "$ref": "#\/definitions\/review" }, "x-example": "", @@ -103979,7 +103874,6 @@ "type": "array", "description": "Credits", "items": { - "type": "object", "$ref": "#\/definitions\/credit" }, "x-example": 5 @@ -104415,7 +104309,6 @@ "type": "array", "description": "Column metadata in result-set order.", "items": { - "type": "object", "$ref": "#\/definitions\/dedicatedDatabaseExecutionColumn" }, "x-example": [] @@ -104608,16 +104501,16 @@ "current": 12, "max": 100 }, - "items": { - "type": "object", - "$ref": "#\/definitions\/databaseStatusConnections" - } + "allOf": [ + { + "$ref": "#\/definitions\/databaseStatusConnections" + } + ] }, "replicas": { "type": "array", "description": "List of database replicas and their status.", "items": { - "type": "object", "$ref": "#\/definitions\/databaseStatusReplica" }, "x-example": [ @@ -104639,7 +104532,6 @@ "type": "array", "description": "Storage volume information.", "items": { - "type": "object", "$ref": "#\/definitions\/databaseStatusVolume" }, "x-example": { @@ -104874,7 +104766,6 @@ "type": "array", "description": "Dns records", "items": { - "type": "object", "$ref": "#\/definitions\/dnsRecord" }, "x-example": [] @@ -105263,7 +105154,6 @@ "type": "array", "description": "Estimation items", "items": { - "type": "object", "$ref": "#\/definitions\/estimation_item" }, "x-example": [] @@ -105272,7 +105162,6 @@ "type": "array", "description": "Estimation discount items", "items": { - "type": "object", "$ref": "#\/definitions\/estimation_item" }, "x-example": [] @@ -105318,7 +105207,6 @@ "type": "array", "description": "List of unpaid invoices", "items": { - "type": "object", "$ref": "#\/definitions\/invoice" }, "x-example": [] @@ -105379,19 +105267,21 @@ "type": "object", "description": "Cost estimation details", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/planChangeEstimationDetails" - } + "allOf": [ + { + "$ref": "#\/definitions\/planChangeEstimationDetails" + } + ] }, "limits": { "type": "object", "description": "Plan limits and compliance information", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/planChangeLimits" - } + "allOf": [ + { + "$ref": "#\/definitions\/planChangeLimits" + } + ] } }, "required": [ @@ -105441,7 +105331,6 @@ "type": "array", "description": "Estimation items", "items": { - "type": "object", "$ref": "#\/definitions\/estimation_item" }, "x-example": [] @@ -105450,7 +105339,6 @@ "type": "array", "description": "Estimation discount items", "items": { - "type": "object", "$ref": "#\/definitions\/estimation_item" }, "x-example": [] @@ -105601,7 +105489,6 @@ "type": "array", "description": "List of replica statuses.", "items": { - "type": "object", "$ref": "#\/definitions\/dedicatedDatabaseHAReplica" }, "x-example": [] @@ -105668,7 +105555,6 @@ "type": "array", "description": "Usage breakdown per resource", "items": { - "type": "object", "$ref": "#\/definitions\/usageResources" }, "x-example": [] @@ -105846,10 +105732,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "type": "object", - "$ref": "#\/definitions\/preferences" - } + "allOf": [ + { + "$ref": "#\/definitions\/preferences" + } + ] }, "billingBudget": { "type": "integer", @@ -105883,10 +105770,11 @@ "type": "object", "description": "Organization's billing plan.", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/billingPlan" - } + "allOf": [ + { + "$ref": "#\/definitions\/billingPlan" + } + ] }, "billingEmail": { "type": "string", @@ -105983,10 +105871,11 @@ "type": "object", "description": "Billing limits reached", "x-example": "", - "items": { - "type": "object", - "$ref": "#\/definitions\/billingLimits" - }, + "allOf": [ + { + "$ref": "#\/definitions\/billingLimits" + } + ], "x-nullable": true }, "billingPlanDowngrade": { @@ -106459,7 +106348,6 @@ "type": "array", "description": "Project compliance details", "items": { - "type": "object", "$ref": "#\/definitions\/planChangeProjectCompliance" }, "x-example": [] @@ -106515,7 +106403,6 @@ "type": "array", "description": "Resource compliance details", "items": { - "type": "object", "$ref": "#\/definitions\/planChangeResourceCompliance" }, "x-example": [] @@ -106659,6 +106546,11 @@ "description": "Policy backup schedule in CRON format.", "x-example": "0 * * * *" }, + "type": { + "type": "string", + "description": "Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup).", + "x-example": "full" + }, "enabled": { "type": "boolean", "description": "Is this policy enabled.", @@ -106674,6 +106566,7 @@ "resources", "retention", "schedule", + "type", "enabled" ], "example": { @@ -106687,6 +106580,7 @@ "resourceType": "database", "retention": 7, "schedule": "0 * * * *", + "type": "full", "enabled": true } }, @@ -106926,7 +106820,6 @@ "type": "array", "description": "Structured query execution plan. Contents are engine-specific.", "items": { - "type": "object", "$ref": "#\/definitions\/any" }, "x-example": [] @@ -107105,7 +106998,6 @@ "type": "array", "description": "List of restorations.", "items": { - "type": "object", "$ref": "#\/definitions\/dedicatedDatabaseRestoration" }, "x-example": "" @@ -107322,7 +107214,6 @@ "type": "array", "description": "List of dedicated database specifications.", "items": { - "type": "object", "$ref": "#\/definitions\/dedicatedDatabaseSpecification" }, "x-example": [] @@ -107337,10 +107228,11 @@ "type": "object", "description": "Overage and add-on pricing shared across all specifications.", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/dedicatedDatabaseSpecificationPricing" - } + "allOf": [ + { + "$ref": "#\/definitions\/dedicatedDatabaseSpecificationPricing" + } + ] } }, "required": [ @@ -107524,100 +107416,111 @@ "type": "object", "description": "Bandwidth additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] }, "executions": { "type": "object", "description": "Executions additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] }, "member": { "type": "object", "description": "Member additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] }, "realtime": { "type": "object", "description": "Realtime additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] }, "realtimeMessages": { "type": "object", "description": "Realtime messages additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] }, "realtimeBandwidth": { "type": "object", "description": "Realtime bandwidth additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] }, "storage": { "type": "object", "description": "Storage additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] }, "users": { "type": "object", "description": "User additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] }, "GBHours": { "type": "object", "description": "GBHour additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] }, "imageTransformations": { "type": "object", "description": "Image transformation additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] }, "credits": { "type": "object", "description": "Credits additional resources", "x-example": null, - "items": { - "type": "object", - "$ref": "#\/definitions\/additionalResource" - } + "allOf": [ + { + "$ref": "#\/definitions\/additionalResource" + } + ] } }, "required": [ @@ -107782,7 +107685,6 @@ "type": "array", "description": "Aggregated stats for number of requests.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -107791,7 +107693,6 @@ "type": "array", "description": "Aggregated stats for consumed bandwidth.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -107800,7 +107701,6 @@ "type": "array", "description": "Aggregated stats for function executions.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -107809,7 +107709,6 @@ "type": "array", "description": "Aggregated stats for database reads.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -107818,7 +107717,6 @@ "type": "array", "description": "Aggregated stats for database writes.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -107827,7 +107725,6 @@ "type": "array", "description": "Aggregated stats for file transformations.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -107842,7 +107739,6 @@ "type": "array", "description": "Aggregated stats for file transformations.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -107857,7 +107753,6 @@ "type": "array", "description": "Aggregated stats for imagine credits.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -107956,7 +107851,6 @@ "type": "array", "description": "Aggregated stats for each projects.", "items": { - "type": "object", "$ref": "#\/definitions\/usageOrganizationProject" }, "x-example": [] @@ -107965,7 +107859,6 @@ "type": "array", "description": "Aggregated stats for realtime connections.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -107980,7 +107873,6 @@ "type": "array", "description": "Aggregated stats for realtime messages.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -107995,7 +107887,6 @@ "type": "array", "description": "Aggregated stats for realtime bandwidth.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -108089,7 +107980,6 @@ "type": "array", "description": "Aggregated stats for number of requests.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -108098,7 +107988,6 @@ "type": "array", "description": "Aggregated stats for consumed bandwidth.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -108113,7 +108002,6 @@ "type": "array", "description": "Aggregated stats for database reads.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -108122,7 +108010,6 @@ "type": "array", "description": "Aggregated stats for database writes.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -108173,7 +108060,6 @@ "type": "array", "description": "Aggregated stats for file transformations.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -108188,7 +108074,6 @@ "type": "array", "description": "Aggregated stats for file transformations.", "items": { - "type": "object", "$ref": "#\/definitions\/metric" }, "x-example": [] @@ -108424,7 +108309,6 @@ "type": "array", "description": "List of application secrets.", "items": { - "type": "object", "$ref": "#\/definitions\/appSecret" }, "x-example": [] @@ -108633,7 +108517,6 @@ "type": "array", "description": "List of events.", "items": { - "type": "object", "$ref": "#\/definitions\/activityEvent" }, "x-example": "" @@ -108662,7 +108545,6 @@ "type": "array", "description": "List of addons.", "items": { - "type": "object", "$ref": "#\/definitions\/addon" }, "x-example": "" @@ -108691,7 +108573,6 @@ "type": "array", "description": "List of aggregations.", "items": { - "type": "object", "$ref": "#\/definitions\/aggregationTeam" }, "x-example": "" @@ -108720,7 +108601,6 @@ "type": "array", "description": "List of archives.", "items": { - "type": "object", "$ref": "#\/definitions\/backupArchive" }, "x-example": "" @@ -108749,7 +108629,6 @@ "type": "array", "description": "List of policies.", "items": { - "type": "object", "$ref": "#\/definitions\/backupPolicy" }, "x-example": "" @@ -108778,7 +108657,6 @@ "type": "array", "description": "List of restorations.", "items": { - "type": "object", "$ref": "#\/definitions\/backupRestoration" }, "x-example": "" @@ -108807,7 +108685,6 @@ "type": "array", "description": "List of billingAddresses.", "items": { - "type": "object", "$ref": "#\/definitions\/billingAddress" }, "x-example": "" @@ -108836,7 +108713,6 @@ "type": "array", "description": "List of invoices.", "items": { - "type": "object", "$ref": "#\/definitions\/invoice" }, "x-example": "" @@ -108865,7 +108741,6 @@ "type": "array", "description": "List of plans.", "items": { - "type": "object", "$ref": "#\/definitions\/billingPlan" }, "x-example": "" @@ -108894,7 +108769,6 @@ "type": "array", "description": "List of blocks.", "items": { - "type": "object", "$ref": "#\/definitions\/block" }, "x-example": "" @@ -108923,7 +108797,6 @@ "type": "array", "description": "List of connections.", "items": { - "type": "object", "$ref": "#\/definitions\/dedicatedDatabaseConnection" }, "x-example": "" @@ -108952,7 +108825,6 @@ "type": "array", "description": "List of slowQueries.", "items": { - "type": "object", "$ref": "#\/definitions\/dedicatedDatabaseSlowQuery" }, "x-example": "" @@ -108981,7 +108853,6 @@ "type": "array", "description": "List of databases.", "items": { - "type": "object", "$ref": "#\/definitions\/dedicatedDatabase" }, "x-example": "" @@ -109010,7 +108881,6 @@ "type": "array", "description": "List of dnsRecords.", "items": { - "type": "object", "$ref": "#\/definitions\/dnsRecord" }, "x-example": "" @@ -109039,7 +108909,6 @@ "type": "array", "description": "List of suggestions.", "items": { - "type": "object", "$ref": "#\/definitions\/domainSuggestion" }, "x-example": "" @@ -109068,7 +108937,6 @@ "type": "array", "description": "List of domains.", "items": { - "type": "object", "$ref": "#\/definitions\/domain" }, "x-example": "" @@ -109097,7 +108965,6 @@ "type": "array", "description": "List of teams.", "items": { - "type": "object", "$ref": "#\/definitions\/organization" }, "x-example": "" @@ -109126,7 +108993,6 @@ "type": "array", "description": "List of paymentMethods.", "items": { - "type": "object", "$ref": "#\/definitions\/paymentMethod" }, "x-example": "" @@ -109155,7 +109021,6 @@ "type": "array", "description": "List of regions.", "items": { - "type": "object", "$ref": "#\/definitions\/consoleRegion" }, "x-example": "" @@ -109184,7 +109049,6 @@ "type": "array", "description": "List of events.", "items": { - "type": "object", "$ref": "#\/definitions\/usageEvent" }, "x-example": "" @@ -109213,7 +109077,6 @@ "type": "array", "description": "List of gauges.", "items": { - "type": "object", "$ref": "#\/definitions\/usageGauge" }, "x-example": "" @@ -109242,7 +109105,6 @@ "type": "array", "description": "List of apps.", "items": { - "type": "object", "$ref": "#\/definitions\/app" }, "x-example": "" @@ -109271,7 +109133,6 @@ "type": "array", "description": "List of secrets.", "items": { - "type": "object", "$ref": "#\/definitions\/appSecret" }, "x-example": "" diff --git a/specs/1.9.x/swagger2-1.9.x-server.json b/specs/1.9.x/swagger2-1.9.x-server.json index 14397000..195ec337 100644 --- a/specs/1.9.x/swagger2-1.9.x-server.json +++ b/specs/1.9.x/swagger2-1.9.x-server.json @@ -11741,7 +11741,14 @@ "type": "array", "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } } }, "required": [ @@ -11847,7 +11854,14 @@ "type": "array", "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } }, "newKey": { "type": "string", @@ -12396,7 +12410,11 @@ "type": "array", "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.", "x-example": "[1, 2]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "number", + "format": "double" + } } }, "required": [ @@ -12502,7 +12520,11 @@ "type": "array", "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.", "x-example": "[1, 2]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "number", + "format": "double" + } }, "newKey": { "type": "string", @@ -12611,7 +12633,17 @@ "type": "array", "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } } }, "required": [ @@ -12717,7 +12749,17 @@ "type": "array", "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } }, "newKey": { "type": "string", @@ -14768,28 +14810,24 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } + "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.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -15243,19 +15281,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -17740,27 +17771,24 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } + "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.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -18187,18 +18215,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -49877,7 +49899,14 @@ "type": "array", "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } } }, "required": [ @@ -49984,7 +50013,14 @@ "type": "array", "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.", "x-example": "[[1, 2], [3, 4], [5, 6]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } }, "newKey": { "type": "string", @@ -50554,7 +50590,11 @@ "type": "array", "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", "x-example": "[1, 2]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "number", + "format": "double" + } } }, "required": [ @@ -50661,7 +50701,11 @@ "type": "array", "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.", "x-example": "[1, 2]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "number", + "format": "double" + } }, "newKey": { "type": "string", @@ -50771,7 +50815,17 @@ "type": "array", "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } } }, "required": [ @@ -50878,7 +50932,17 @@ "type": "array", "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.", "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", - "x-nullable": true + "x-nullable": true, + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } }, "newKey": { "type": "string", @@ -53343,28 +53407,24 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } + "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.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -53807,19 +53867,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -61440,27 +61493,24 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "queries": { - "type": "array", - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } + "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.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -61890,18 +61940,12 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "" - } - } - } + "name": "transactionId", + "description": "Transaction ID for staging the operation.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] } @@ -62898,7 +62942,6 @@ "type": "array", "description": "List of rows.", "items": { - "type": "object", "$ref": "#\/definitions\/row" }, "x-example": "" @@ -62927,7 +62970,6 @@ "type": "array", "description": "List of documents.", "items": { - "type": "object", "$ref": "#\/definitions\/document" }, "x-example": "" @@ -62956,7 +62998,6 @@ "type": "array", "description": "List of presences.", "items": { - "type": "object", "$ref": "#\/definitions\/presence" }, "x-example": "" @@ -62985,7 +63026,6 @@ "type": "array", "description": "List of tables.", "items": { - "type": "object", "$ref": "#\/definitions\/table" }, "x-example": "" @@ -63014,7 +63054,6 @@ "type": "array", "description": "List of collections.", "items": { - "type": "object", "$ref": "#\/definitions\/collection" }, "x-example": "" @@ -63043,7 +63082,6 @@ "type": "array", "description": "List of databases.", "items": { - "type": "object", "$ref": "#\/definitions\/database" }, "x-example": "" @@ -63072,7 +63110,6 @@ "type": "array", "description": "List of indexes.", "items": { - "type": "object", "$ref": "#\/definitions\/index" }, "x-example": "" @@ -63101,7 +63138,6 @@ "type": "array", "description": "List of indexes.", "items": { - "type": "object", "$ref": "#\/definitions\/columnIndex" }, "x-example": "" @@ -63130,7 +63166,6 @@ "type": "array", "description": "List of users.", "items": { - "type": "object", "$ref": "#\/definitions\/user" }, "x-example": "" @@ -63159,7 +63194,6 @@ "type": "array", "description": "List of sessions.", "items": { - "type": "object", "$ref": "#\/definitions\/session" }, "x-example": "" @@ -63188,7 +63222,6 @@ "type": "array", "description": "List of identities.", "items": { - "type": "object", "$ref": "#\/definitions\/identity" }, "x-example": "" @@ -63217,7 +63250,6 @@ "type": "array", "description": "List of logs.", "items": { - "type": "object", "$ref": "#\/definitions\/log" }, "x-example": "" @@ -63246,7 +63278,6 @@ "type": "array", "description": "List of files.", "items": { - "type": "object", "$ref": "#\/definitions\/file" }, "x-example": "" @@ -63275,7 +63306,6 @@ "type": "array", "description": "List of buckets.", "items": { - "type": "object", "$ref": "#\/definitions\/bucket" }, "x-example": "" @@ -63304,7 +63334,6 @@ "type": "array", "description": "List of tokens.", "items": { - "type": "object", "$ref": "#\/definitions\/resourceToken" }, "x-example": "" @@ -63333,7 +63362,6 @@ "type": "array", "description": "List of teams.", "items": { - "type": "object", "$ref": "#\/definitions\/team" }, "x-example": "" @@ -63362,7 +63390,6 @@ "type": "array", "description": "List of memberships.", "items": { - "type": "object", "$ref": "#\/definitions\/membership" }, "x-example": "" @@ -63391,7 +63418,6 @@ "type": "array", "description": "List of sites.", "items": { - "type": "object", "$ref": "#\/definitions\/site" }, "x-example": "" @@ -63420,7 +63446,6 @@ "type": "array", "description": "List of functions.", "items": { - "type": "object", "$ref": "#\/definitions\/function" }, "x-example": "" @@ -63449,7 +63474,6 @@ "type": "array", "description": "List of frameworks.", "items": { - "type": "object", "$ref": "#\/definitions\/framework" }, "x-example": "" @@ -63478,7 +63502,6 @@ "type": "array", "description": "List of runtimes.", "items": { - "type": "object", "$ref": "#\/definitions\/runtime" }, "x-example": "" @@ -63507,7 +63530,6 @@ "type": "array", "description": "List of deployments.", "items": { - "type": "object", "$ref": "#\/definitions\/deployment" }, "x-example": "" @@ -63536,7 +63558,6 @@ "type": "array", "description": "List of executions.", "items": { - "type": "object", "$ref": "#\/definitions\/execution" }, "x-example": "" @@ -63565,7 +63586,6 @@ "type": "array", "description": "List of projects.", "items": { - "type": "object", "$ref": "#\/definitions\/project" }, "x-example": "" @@ -63594,7 +63614,6 @@ "type": "array", "description": "List of webhooks.", "items": { - "type": "object", "$ref": "#\/definitions\/webhook" }, "x-example": "" @@ -63623,7 +63642,6 @@ "type": "array", "description": "List of keys.", "items": { - "type": "object", "$ref": "#\/definitions\/key" }, "x-example": "" @@ -63652,7 +63670,6 @@ "type": "array", "description": "List of countries.", "items": { - "type": "object", "$ref": "#\/definitions\/country" }, "x-example": "" @@ -63681,7 +63698,6 @@ "type": "array", "description": "List of continents.", "items": { - "type": "object", "$ref": "#\/definitions\/continent" }, "x-example": "" @@ -63710,7 +63726,6 @@ "type": "array", "description": "List of languages.", "items": { - "type": "object", "$ref": "#\/definitions\/language" }, "x-example": "" @@ -63739,7 +63754,6 @@ "type": "array", "description": "List of currencies.", "items": { - "type": "object", "$ref": "#\/definitions\/currency" }, "x-example": "" @@ -63768,7 +63782,6 @@ "type": "array", "description": "List of phones.", "items": { - "type": "object", "$ref": "#\/definitions\/phone" }, "x-example": "" @@ -63797,7 +63810,6 @@ "type": "array", "description": "List of variables.", "items": { - "type": "object", "$ref": "#\/definitions\/variable" }, "x-example": "" @@ -63826,7 +63838,6 @@ "type": "array", "description": "List of mockNumbers.", "items": { - "type": "object", "$ref": "#\/definitions\/mockNumber" }, "x-example": "" @@ -63941,7 +63952,6 @@ "type": "array", "description": "List of templates.", "items": { - "type": "object", "$ref": "#\/definitions\/emailTemplate" }, "x-example": "" @@ -63970,7 +63980,6 @@ "type": "array", "description": "List of statuses.", "items": { - "type": "object", "$ref": "#\/definitions\/healthStatus" }, "x-example": "" @@ -63999,7 +64008,6 @@ "type": "array", "description": "List of rules.", "items": { - "type": "object", "$ref": "#\/definitions\/proxyRule" }, "x-example": "" @@ -64028,7 +64036,6 @@ "type": "array", "description": "List of localeCodes.", "items": { - "type": "object", "$ref": "#\/definitions\/localeCode" }, "x-example": "" @@ -64057,7 +64064,6 @@ "type": "array", "description": "List of providers.", "items": { - "type": "object", "$ref": "#\/definitions\/provider" }, "x-example": "" @@ -64086,7 +64092,6 @@ "type": "array", "description": "List of messages.", "items": { - "type": "object", "$ref": "#\/definitions\/message" }, "x-example": "" @@ -64115,7 +64120,6 @@ "type": "array", "description": "List of topics.", "items": { - "type": "object", "$ref": "#\/definitions\/topic" }, "x-example": "" @@ -64144,7 +64148,6 @@ "type": "array", "description": "List of subscribers.", "items": { - "type": "object", "$ref": "#\/definitions\/subscriber" }, "x-example": "" @@ -64173,7 +64176,6 @@ "type": "array", "description": "List of targets.", "items": { - "type": "object", "$ref": "#\/definitions\/target" }, "x-example": "" @@ -64202,7 +64204,6 @@ "type": "array", "description": "List of transactions.", "items": { - "type": "object", "$ref": "#\/definitions\/transaction" }, "x-example": "" @@ -64231,7 +64232,6 @@ "type": "array", "description": "List of specifications.", "items": { - "type": "object", "$ref": "#\/definitions\/specification" }, "x-example": "" @@ -64260,7 +64260,6 @@ "type": "array", "description": "List of collections.", "items": { - "type": "object", "$ref": "#\/definitions\/vectorsdbCollection" }, "x-example": "" @@ -64289,7 +64288,6 @@ "type": "array", "description": "List of embeddings.", "items": { - "type": "object", "$ref": "#\/definitions\/embedding" }, "x-example": "" @@ -64318,7 +64316,6 @@ "type": "array", "description": "List of insights.", "items": { - "type": "object", "$ref": "#\/definitions\/insight" }, "x-example": "" @@ -64347,7 +64344,6 @@ "type": "array", "description": "List of reports.", "items": { - "type": "object", "$ref": "#\/definitions\/report" }, "x-example": "" @@ -64406,7 +64402,6 @@ "type": "array", "description": "Database backup policies.", "items": { - "type": "object", "$ref": "#\/definitions\/backupPolicy" }, "x-example": {} @@ -64415,7 +64410,6 @@ "type": "array", "description": "Database backup archives.", "items": { - "type": "object", "$ref": "#\/definitions\/backupArchive" }, "x-example": {} @@ -64692,7 +64686,6 @@ "type": "array", "description": "Collection indexes.", "items": { - "type": "object", "$ref": "#\/definitions\/index" }, "x-example": {} @@ -66004,6 +65997,10 @@ 0, 0 ], + "items": { + "type": "number", + "format": "double" + }, "x-nullable": true } }, @@ -66097,6 +66094,13 @@ 1 ] ], + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, "x-nullable": true } }, @@ -66208,6 +66212,16 @@ ] ] ], + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + }, "x-nullable": true } }, @@ -66688,7 +66702,6 @@ "type": "array", "description": "Collection indexes.", "items": { - "type": "object", "$ref": "#\/definitions\/index" }, "x-example": {} @@ -67100,7 +67113,6 @@ "type": "array", "description": "Table indexes.", "items": { - "type": "object", "$ref": "#\/definitions\/columnIndex" }, "x-example": {} @@ -68412,6 +68424,10 @@ 0, 0 ], + "items": { + "type": "number", + "format": "double" + }, "x-nullable": true } }, @@ -68505,6 +68521,13 @@ 1 ] ], + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, "x-nullable": true } }, @@ -68616,6 +68639,16 @@ ] ] ], + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + }, "x-nullable": true } }, @@ -69641,41 +69674,39 @@ "type": "object", "description": "Password hashing algorithm configuration.", "x-example": {}, - "items": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/algoArgon2" - }, - { - "$ref": "#\/definitions\/algoScrypt" - }, - { - "$ref": "#\/definitions\/algoScryptModified" - }, - { - "$ref": "#\/definitions\/algoBcrypt" - }, - { - "$ref": "#\/definitions\/algoPhpass" - }, - { - "$ref": "#\/definitions\/algoSha" - }, - { - "$ref": "#\/definitions\/algoMd5" - } - ], - "x-discriminator": { - "propertyName": "type", - "mapping": { - "argon2": "#\/definitions\/algoArgon2", - "scrypt": "#\/definitions\/algoScrypt", - "scryptMod": "#\/definitions\/algoScryptModified", - "bcrypt": "#\/definitions\/algoBcrypt", - "phpass": "#\/definitions\/algoPhpass", - "sha": "#\/definitions\/algoSha", - "md5": "#\/definitions\/algoMd5" - } + "x-oneOf": [ + { + "$ref": "#\/definitions\/algoArgon2" + }, + { + "$ref": "#\/definitions\/algoScrypt" + }, + { + "$ref": "#\/definitions\/algoScryptModified" + }, + { + "$ref": "#\/definitions\/algoBcrypt" + }, + { + "$ref": "#\/definitions\/algoPhpass" + }, + { + "$ref": "#\/definitions\/algoSha" + }, + { + "$ref": "#\/definitions\/algoMd5" + } + ], + "x-discriminator": { + "propertyName": "type", + "mapping": { + "argon2": "#\/definitions\/algoArgon2", + "scrypt": "#\/definitions\/algoScrypt", + "scryptMod": "#\/definitions\/algoScryptModified", + "bcrypt": "#\/definitions\/algoBcrypt", + "phpass": "#\/definitions\/algoPhpass", + "sha": "#\/definitions\/algoSha", + "md5": "#\/definitions\/algoMd5" } }, "x-nullable": true @@ -69767,16 +69798,16 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "type": "object", - "$ref": "#\/definitions\/preferences" - } + "allOf": [ + { + "$ref": "#\/definitions\/preferences" + } + ] }, "targets": { "type": "array", "description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.", "items": { - "type": "object", "$ref": "#\/definitions\/target" }, "x-example": [] @@ -70850,10 +70881,11 @@ "theme": "pink", "timezone": "UTC" }, - "items": { - "type": "object", - "$ref": "#\/definitions\/preferences" - } + "allOf": [ + { + "$ref": "#\/definitions\/preferences" + } + ] } }, "required": [ @@ -71087,7 +71119,6 @@ "type": "array", "description": "Site variables.", "items": { - "type": "object", "$ref": "#\/definitions\/variable" }, "x-example": [] @@ -71365,7 +71396,6 @@ "type": "array", "description": "Function variables.", "items": { - "type": "object", "$ref": "#\/definitions\/variable" }, "x-example": [] @@ -71640,7 +71670,6 @@ "type": "array", "description": "List of supported adapters.", "items": { - "type": "object", "$ref": "#\/definitions\/frameworkAdapter" }, "x-example": [ @@ -72011,7 +72040,6 @@ "type": "array", "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", "items": { - "type": "object", "$ref": "#\/definitions\/headers" }, "x-example": [ @@ -72035,7 +72063,6 @@ "type": "array", "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.", "items": { - "type": "object", "$ref": "#\/definitions\/headers" }, "x-example": [ @@ -72155,7 +72182,6 @@ "type": "array", "description": "Deprecated since 1.9.5: List of dev keys.", "items": { - "type": "object", "$ref": "#\/definitions\/devKey" }, "x-example": {} @@ -72242,7 +72268,6 @@ "type": "array", "description": "List of auth methods.", "items": { - "type": "object", "$ref": "#\/definitions\/projectAuthMethod" }, "x-example": {} @@ -72251,7 +72276,6 @@ "type": "array", "description": "List of services.", "items": { - "type": "object", "$ref": "#\/definitions\/projectService" }, "x-example": {} @@ -72260,7 +72284,6 @@ "type": "array", "description": "List of protocols.", "items": { - "type": "object", "$ref": "#\/definitions\/projectProtocol" }, "x-example": {} @@ -72269,7 +72292,6 @@ "type": "array", "description": "Project blocks information", "items": { - "type": "object", "$ref": "#\/definitions\/block" }, "x-example": "" @@ -72283,10 +72305,11 @@ "type": "object", "description": "Billing limits reached", "x-example": "", - "items": { - "type": "object", - "$ref": "#\/definitions\/billingLimits" - }, + "allOf": [ + { + "$ref": "#\/definitions\/billingLimits" + } + ], "x-nullable": true }, "oAuth2ServerEnabled": { @@ -76635,10 +76658,11 @@ "identifier": "random-mail@email.org", "userId": "5e5ea5c16897e" }, - "items": { - "type": "object", - "$ref": "#\/definitions\/target" - } + "allOf": [ + { + "$ref": "#\/definitions\/target" + } + ] }, "userId": { "type": "string", @@ -76839,7 +76863,6 @@ "type": "array", "description": "List of call-to-action buttons attached to this insight.", "items": { - "type": "object", "$ref": "#\/definitions\/insightCTA" }, "x-example": [] @@ -77018,7 +77041,6 @@ "type": "array", "description": "Insights nested under this report.", "items": { - "type": "object", "$ref": "#\/definitions\/insight" }, "x-example": [] @@ -77527,6 +77549,11 @@ "description": "Policy backup schedule in CRON format.", "x-example": "0 * * * *" }, + "type": { + "type": "string", + "description": "Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup).", + "x-example": "full" + }, "enabled": { "type": "boolean", "description": "Is this policy enabled.", @@ -77542,6 +77569,7 @@ "resources", "retention", "schedule", + "type", "enabled" ], "example": { @@ -77555,6 +77583,7 @@ "resourceType": "database", "retention": 7, "schedule": "0 * * * *", + "type": "full", "enabled": true } }, @@ -77948,7 +77977,6 @@ "type": "array", "description": "List of application secrets.", "items": { - "type": "object", "$ref": "#\/definitions\/appSecret" }, "x-example": [] @@ -78314,7 +78342,6 @@ "type": "array", "description": "List of events.", "items": { - "type": "object", "$ref": "#\/definitions\/activityEvent" }, "x-example": "" @@ -78343,7 +78370,6 @@ "type": "array", "description": "List of archives.", "items": { - "type": "object", "$ref": "#\/definitions\/backupArchive" }, "x-example": "" @@ -78372,7 +78398,6 @@ "type": "array", "description": "List of policies.", "items": { - "type": "object", "$ref": "#\/definitions\/backupPolicy" }, "x-example": "" @@ -78401,7 +78426,6 @@ "type": "array", "description": "List of restorations.", "items": { - "type": "object", "$ref": "#\/definitions\/backupRestoration" }, "x-example": "" @@ -78430,7 +78454,6 @@ "type": "array", "description": "List of events.", "items": { - "type": "object", "$ref": "#\/definitions\/usageEvent" }, "x-example": "" @@ -78459,7 +78482,6 @@ "type": "array", "description": "List of gauges.", "items": { - "type": "object", "$ref": "#\/definitions\/usageGauge" }, "x-example": "" @@ -78488,7 +78510,6 @@ "type": "array", "description": "List of apps.", "items": { - "type": "object", "$ref": "#\/definitions\/app" }, "x-example": "" @@ -78517,7 +78538,6 @@ "type": "array", "description": "List of secrets.", "items": { - "type": "object", "$ref": "#\/definitions\/appSecret" }, "x-example": ""