From 698f5834d5662e2608393e32a7e68a2d18d4eef2 Mon Sep 17 00:00:00 2001 From: Chirag Aggarwal Date: Wed, 19 Aug 2026 14:21:26 +0530 Subject: [PATCH 1/2] chore: use standard OpenAPI schema fields --- specs/1.9.x/open-api3-1.9.x-client.json | 2395 ++-- specs/1.9.x/open-api3-1.9.x-console.json | 15181 ++++++++++----------- specs/1.9.x/open-api3-1.9.x-server.json | 11956 ++++++++-------- 3 files changed, 14708 insertions(+), 14824 deletions(-) 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 1a673993c..e69ca8790 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 @@ -139,7 +139,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -147,20 +147,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -242,7 +242,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -305,7 +305,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -361,7 +361,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -423,7 +423,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -446,7 +446,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -509,7 +509,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -519,7 +519,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -575,7 +575,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -585,7 +585,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -650,13 +650,13 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -739,7 +739,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -796,7 +796,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -860,7 +860,7 @@ "type": "integer", "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", "default": 900, - "x-example": 0, + "example": 0, "format": "int32" } } @@ -939,7 +939,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -1005,7 +1005,7 @@ "mfa": { "type": "boolean", "description": "Enable or disable MFA.", - "x-example": false + "example": false } }, "required": [ @@ -1129,7 +1129,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -1257,7 +1257,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -1278,7 +1278,7 @@ "otp": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -1391,7 +1391,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -1519,7 +1519,7 @@ "factor": { "type": "string", "description": "Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`, `custom`.", - "x-example": "email", + "example": "email", "enum": [ "email", "phone", @@ -1662,12 +1662,12 @@ "challengeId": { "type": "string", "description": "ID of the challenge.", - "x-example": "" + "example": "" }, "otp": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -2130,7 +2130,7 @@ "name": { "type": "string", "description": "User name. Max length: 128 chars.", - "x-example": "" + "example": "" } }, "required": [ @@ -2200,14 +2200,14 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" }, "oldPassword": { "type": "string", "description": "Current user password. Max length: 256 chars.", "default": "", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -2278,13 +2278,13 @@ "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "password": { "type": "string", "description": "User password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -2406,7 +2406,11 @@ "type": "object", "description": "Prefs key-value JSON object.", "default": {}, - "x-example": "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}" + "example": { + "language": "en", + "timezone": "UTC", + "darkTheme": true + } } }, "required": [ @@ -2479,13 +2483,13 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "url": { "type": "string", "description": "URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" } }, @@ -2555,17 +2559,17 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "" + "example": "" }, "secret": { "type": "string", "description": "Valid reset token.", - "x-example": "" + "example": "" }, "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -2782,13 +2786,13 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -2864,7 +2868,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -2872,7 +2876,7 @@ "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -2942,7 +2946,7 @@ "required": true, "schema": { "type": "string", - "x-example": "amazon", + "example": "amazon", "enum": [ "amazon", "apple", @@ -3046,7 +3050,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -3058,7 +3062,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -3141,7 +3145,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -3149,7 +3153,7 @@ "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -3220,7 +3224,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -3228,7 +3232,7 @@ "secret": { "type": "string", "description": "Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.", - "x-example": "" + "example": "" } }, "required": [ @@ -3297,7 +3301,7 @@ "required": true, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "current" }, "in": "path" @@ -3359,7 +3363,7 @@ "required": true, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "current" }, "in": "path" @@ -3414,7 +3418,7 @@ "required": true, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "current" }, "in": "path" @@ -3529,7 +3533,7 @@ "targetId": { "type": "string", "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -3537,13 +3541,13 @@ "identifier": { "type": "string", "description": "The target identifier (token, email, phone etc.)", - "x-example": "" + "example": "" }, "providerId": { "type": "string", "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -3610,7 +3614,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -3624,7 +3628,7 @@ "identifier": { "type": "string", "description": "The target identifier (token, email, phone etc.)", - "x-example": "" + "example": "" } }, "required": [ @@ -3681,7 +3685,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -3749,7 +3753,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -3757,14 +3761,14 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "phrase": { "type": "boolean", "description": "Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -3838,7 +3842,7 @@ "userId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -3846,21 +3850,21 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "url": { "type": "string", "description": "URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "phrase": { "type": "boolean", "description": "Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -3930,7 +3934,7 @@ "required": true, "schema": { "type": "string", - "x-example": "amazon", + "example": "amazon", "enum": [ "amazon", "apple", @@ -4034,7 +4038,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -4046,7 +4050,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -4128,7 +4132,7 @@ "userId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -4136,7 +4140,7 @@ "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" } }, @@ -4260,7 +4264,7 @@ "url": { "type": "string", "description": "URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" } }, @@ -4385,12 +4389,12 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "" + "example": "" }, "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -4513,12 +4517,12 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "" + "example": "" }, "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -4599,7 +4603,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -4662,7 +4666,7 @@ "appId": { "type": "string", "description": "Application ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -4670,47 +4674,46 @@ "name": { "type": "string", "description": "Application name.", - "x-example": "" + "example": "" }, "description": { "type": "string", "description": "Application description shown to users during OAuth2 consent.", "default": "", - "x-example": "" + "example": "" }, "clientUri": { "type": "string", "description": "Application homepage URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "logoUri": { "type": "string", "description": "Application logo URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "privacyPolicyUrl": { "type": "string", "description": "Application privacy policy URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "termsUrl": { "type": "string", "description": "Application terms of service URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "contacts": { "type": "array", "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4719,13 +4722,12 @@ "type": "string", "description": "Application tagline shown to users during OAuth2 consent.", "default": "", - "x-example": "" + "example": "" }, "tags": { "type": "array", "description": "Application tags shown to users during OAuth2 consent. Maximum of 100 tags are allowed, each up to 64 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4734,7 +4736,6 @@ "type": "array", "description": "Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4743,20 +4744,19 @@ "type": "string", "description": "Application support URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "dataDeletionUrl": { "type": "string", "description": "Application data deletion URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "redirectUris": { "type": "array", "description": "Redirect URIs. Each must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI (e.g. com.example.app:\/oauth), and must not contain a fragment.", - "x-example": null, "items": { "type": "string" } @@ -4765,7 +4765,6 @@ "type": "array", "description": "Post-logout redirect URIs for OpenID Connect RP-Initiated Logout. Each must be an https URL, an http loopback URL, or a private-use scheme URI, and must not contain a fragment. After ending the user session, the logout endpoint only redirects to URIs in this list.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4774,25 +4773,25 @@ "type": "boolean", "description": "Is application enabled?", "default": true, - "x-example": false + "example": false }, "type": { "type": "string", "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", "default": "confidential", - "x-example": "public" + "example": "public" }, "deviceFlow": { "type": "boolean", "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", "default": false, - "x-example": false + "example": false }, "teamId": { "type": "string", "description": "Team unique ID.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -4961,7 +4960,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -5021,7 +5020,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -5035,47 +5034,46 @@ "name": { "type": "string", "description": "Application name.", - "x-example": "" + "example": "" }, "description": { "type": "string", "description": "Application description shown to users during OAuth2 consent.", "default": "", - "x-example": "" + "example": "" }, "clientUri": { "type": "string", "description": "Application homepage URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "logoUri": { "type": "string", "description": "Application logo URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "privacyPolicyUrl": { "type": "string", "description": "Application privacy policy URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "termsUrl": { "type": "string", "description": "Application terms of service URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "contacts": { "type": "array", "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -5084,13 +5082,12 @@ "type": "string", "description": "Application tagline shown to users during OAuth2 consent.", "default": "", - "x-example": "" + "example": "" }, "tags": { "type": "array", "description": "Application tags shown to users during OAuth2 consent. Maximum of 100 tags are allowed, each up to 64 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -5099,7 +5096,6 @@ "type": "array", "description": "Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -5108,27 +5104,26 @@ "type": "string", "description": "Application support URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "dataDeletionUrl": { "type": "string", "description": "Application data deletion URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "enabled": { "type": "boolean", "description": "Is application enabled?", "default": true, - "x-example": false + "example": false }, "redirectUris": { "type": "array", "description": "Redirect URIs. Each must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI (e.g. com.example.app:\/oauth), and must not contain a fragment.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -5137,7 +5132,6 @@ "type": "array", "description": "Post-logout redirect URIs for OpenID Connect RP-Initiated Logout. Each must be an https URL, an http loopback URL, or a private-use scheme URI, and must not contain a fragment. After ending the user session, the logout endpoint only redirects to URIs in this list.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -5146,19 +5140,18 @@ "type": "string", "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", "default": "confidential", - "x-example": "public" + "example": "public" }, "deviceFlow": { "type": "boolean", "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", "default": false, - "x-example": false + "example": false }, "installationScopes": { "type": "array", "description": "Scopes the application requests when installed on a team. Only scopes allowed by the project's OAuth2 server installation scopes configuration are accepted; use the list installation scopes endpoint to discover available values. Maximum of 100 scopes are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -5167,7 +5160,7 @@ "type": "string", "description": "URL users are redirected to after creating or updating an installation of this application. Must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI, and must not contain a fragment. Leave empty for no redirect.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" } }, @@ -5229,7 +5222,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -5294,7 +5287,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -5317,7 +5310,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -5383,7 +5376,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -5393,7 +5386,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -5449,7 +5442,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -5459,7 +5452,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -5524,7 +5517,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -5534,7 +5527,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -5596,7 +5589,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -5619,7 +5612,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -5680,7 +5673,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -5742,7 +5735,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -5752,7 +5745,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -5808,7 +5801,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -5818,7 +5811,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -5880,7 +5873,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -5903,7 +5896,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -5964,7 +5957,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -6026,7 +6019,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -6036,7 +6029,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -6092,7 +6085,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -6102,7 +6095,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -6164,7 +6157,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -6178,7 +6171,7 @@ "teamId": { "type": "string", "description": "Team ID of the team to transfer application to.", - "x-example": "" + "example": "" } }, "required": [ @@ -6241,7 +6234,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -6307,7 +6300,7 @@ "required": true, "schema": { "type": "string", - "x-example": "aa", + "example": "aa", "enum": [ "aa", "an", @@ -6351,7 +6344,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -6363,7 +6356,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -6375,7 +6368,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -6442,7 +6435,7 @@ "required": true, "schema": { "type": "string", - "x-example": "amex", + "example": "amex", "enum": [ "amex", "argencard", @@ -6492,7 +6485,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -6504,7 +6497,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -6516,7 +6509,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -6584,7 +6577,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" } @@ -6650,7 +6643,7 @@ "required": true, "schema": { "type": "string", - "x-example": "af", + "example": "af", "enum": [ "af", "ao", @@ -7056,7 +7049,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -7068,7 +7061,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -7080,7 +7073,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -7148,7 +7141,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" }, @@ -7159,7 +7152,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 400 }, "in": "query" @@ -7171,7 +7164,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 400 }, "in": "query" @@ -7238,7 +7231,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -7250,7 +7243,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 500 }, "in": "query" @@ -7262,7 +7255,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 500 }, "in": "query" @@ -7339,7 +7332,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -7350,7 +7343,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 400 }, "in": "query" @@ -7362,7 +7355,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 1 }, "in": "query" @@ -7373,7 +7366,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": false }, "in": "query" @@ -7441,7 +7434,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" }, @@ -7452,7 +7445,10 @@ "schema": { "type": "object", "default": [], - "x-example": "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}" + "example": { + "Authorization": "Bearer token123", + "X-Custom-Header": "value" + } }, "in": "query" }, @@ -7463,7 +7459,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "1920", + "example": 1920, "default": 1280 }, "in": "query" @@ -7475,7 +7471,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "1080", + "example": 1080, "default": 720 }, "in": "query" @@ -7487,7 +7483,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "2", + "example": 2, "default": 1 }, "in": "query" @@ -7498,7 +7494,7 @@ "required": false, "schema": { "type": "string", - "x-example": "dark", + "example": "dark", "enum": [ "light", "dark" @@ -7518,7 +7514,7 @@ "required": false, "schema": { "type": "string", - "x-example": "Mozilla\/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit\/605.1.15", + "example": "Mozilla\/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit\/605.1.15", "default": "" }, "in": "query" @@ -7529,7 +7525,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": "true", + "example": true, "default": false }, "in": "query" @@ -7540,7 +7536,7 @@ "required": false, "schema": { "type": "string", - "x-example": "en-US", + "example": "en-US", "default": "" }, "in": "query" @@ -7551,7 +7547,7 @@ "required": false, "schema": { "type": "string", - "x-example": "America\/New_York", + "example": "America\/New_York", "enum": [ "africa\/abidjan", "africa\/accra", @@ -8405,7 +8401,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "37.7749", + "example": 37.7749, "default": 0 }, "in": "query" @@ -8417,7 +8413,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "-122.4194", + "example": -122.4194, "default": 0 }, "in": "query" @@ -8429,7 +8425,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "100", + "example": 100, "default": 0 }, "in": "query" @@ -8440,7 +8436,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": "true", + "example": true, "default": false }, "in": "query" @@ -8499,7 +8495,10 @@ "xr-spatial-tracking" ] }, - "x-example": "[\"geolocation\",\"notifications\"]", + "example": [ + "geolocation", + "notifications" + ], "default": [] }, "in": "query" @@ -8511,7 +8510,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "3", + "example": 3, "default": 0 }, "in": "query" @@ -8523,7 +8522,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "800", + "example": 800, "default": 0 }, "in": "query" @@ -8535,7 +8534,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "600", + "example": 600, "default": 0 }, "in": "query" @@ -8547,7 +8546,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "85", + "example": 85, "default": -1 }, "in": "query" @@ -8558,7 +8557,7 @@ "required": false, "schema": { "type": "string", - "x-example": "jpeg", + "example": "jpeg", "enum": [ "jpg", "jpeg", @@ -8715,7 +8714,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -8785,7 +8784,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -8850,7 +8849,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -8865,13 +8864,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -8931,7 +8930,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -8998,7 +8997,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -9013,7 +9012,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "", + "collectionId": "", + "documentId": "", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -9085,7 +9094,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9095,7 +9104,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9118,7 +9127,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -9128,7 +9137,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -9140,7 +9149,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -9243,7 +9252,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9253,7 +9262,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -9267,7 +9276,7 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -9276,22 +9285,29 @@ "type": "object", "description": "Document data as JSON object.", "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "documents": { "type": "array", "description": "Array of documents data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -9299,8 +9315,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } }, "required": [ @@ -9373,7 +9389,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9383,7 +9399,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9393,7 +9409,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9416,7 +9432,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -9517,7 +9533,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9527,7 +9543,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9540,7 +9556,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "" + "example": "" }, "in": "path" } @@ -9555,22 +9571,30 @@ "type": "object", "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -9637,7 +9661,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9647,7 +9671,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9657,7 +9681,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -9672,22 +9696,30 @@ "type": "object", "description": "Document data as JSON object. Include only attribute 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}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -9747,7 +9779,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9757,7 +9789,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9767,7 +9799,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9777,7 +9809,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -9844,7 +9876,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9854,7 +9886,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9864,7 +9896,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9888,21 +9920,19 @@ "type": "number", "description": "Value to increment the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "min": { "type": "number", "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -9971,7 +10001,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9981,7 +10011,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -9991,7 +10021,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -10015,21 +10045,19 @@ "type": "number", "description": "Value to increment the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "max": { "type": "number", "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -10161,7 +10189,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -10227,7 +10255,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -10288,7 +10316,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -10303,13 +10331,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -10365,7 +10393,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -10427,7 +10455,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -10442,7 +10470,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "", + "collectionId": "", + "documentId": "", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -10510,7 +10548,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -10520,7 +10558,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -10543,7 +10581,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -10553,7 +10591,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -10565,7 +10603,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -10686,7 +10724,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -10696,7 +10734,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -10710,7 +10748,7 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -10719,12 +10757,20 @@ "type": "object", "description": "Document data as JSON object.", "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -10733,7 +10779,6 @@ "type": "array", "description": "Array of documents data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -10741,7 +10786,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } }, "required": [ @@ -10810,7 +10855,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -10820,7 +10865,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -10830,7 +10875,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -10853,7 +10898,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -10946,7 +10991,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -10956,7 +11001,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -10966,7 +11011,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -10981,12 +11026,14 @@ "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -10994,7 +11041,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -11057,7 +11104,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11067,7 +11114,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11077,7 +11124,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -11092,12 +11139,14 @@ "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -11105,7 +11154,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -11161,7 +11210,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11171,7 +11220,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11181,7 +11230,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11191,7 +11240,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -11254,7 +11303,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11264,7 +11313,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11274,7 +11323,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11298,19 +11347,17 @@ "type": "number", "description": "Value to decrement the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "min": { "type": "number", "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, "format": "float" }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -11375,7 +11422,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11385,7 +11432,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11395,7 +11442,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11419,19 +11466,17 @@ "type": "number", "description": "Value to increment the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "max": { "type": "number", "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, "format": "float" }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -11498,7 +11543,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11521,7 +11566,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -11585,7 +11630,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -11600,25 +11645,25 @@ "type": "string", "description": "HTTP body of execution. Default value is empty string.", "default": "", - "x-example": "" + "example": "" }, "async": { "type": "boolean", "description": "Execute code in the background. Default value is false.", "default": false, - "x-example": false + "example": false }, "path": { "type": "string", "description": "HTTP path of execution. Path can include query params. Default value is \/", "default": "\/", - "x-example": "" + "example": "" }, "method": { "type": "string", "description": "HTTP method of execution. Default value is POST.", "default": "POST", - "x-example": "GET", + "example": "GET", "enum": [ "GET", "POST", @@ -11643,13 +11688,13 @@ "type": "object", "description": "HTTP headers of execution. Defaults to empty.", "default": [], - "x-example": "{}" + "example": {} }, "scheduledAt": { "type": "string", "description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -11716,7 +11761,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -11726,7 +11771,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -11792,7 +11837,7 @@ "type": "object", "description": "The query or queries to execute.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -11863,7 +11908,7 @@ "type": "object", "description": "The query or queries to execute.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -12339,7 +12384,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -12353,7 +12398,7 @@ "subscriberId": { "type": "string", "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -12361,7 +12406,7 @@ "targetId": { "type": "string", "description": "Target ID. The target ID to link to the specified Topic ID.", - "x-example": "" + "example": "" } }, "required": [ @@ -12423,7 +12468,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -12433,7 +12478,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -12495,7 +12540,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -12509,19 +12554,19 @@ "grant_id": { "type": "string", "description": "Grant ID made during authorization, provided to consent screen in URL search params.", - "x-example": "" + "example": "" }, "authorization_details": { "type": "string", "description": "Enriched `authorization_details` the user consented to, replacing what the client requested. Each entry must use a `type` the project accepts. Optional; omit to keep the originally requested details.", "default": "", - "x-example": "" + "example": "" }, "scope": { "type": "string", "description": "Space-separated scopes the user consented to. Must be a subset of the scopes originally requested; identity scopes such as `openid` are always retained. Optional; omit to keep the originally requested scopes.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -12588,7 +12633,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -12598,7 +12643,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -12610,7 +12655,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -12621,7 +12666,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -12632,7 +12677,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -12643,7 +12688,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -12654,7 +12699,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -12665,7 +12710,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -12676,7 +12721,7 @@ "required": false, "schema": { "type": "string", - "x-example": "s256", + "example": "s256", "default": "" }, "in": "query" @@ -12687,7 +12732,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -12699,7 +12744,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0 + "example": 0 }, "in": "query" }, @@ -12709,7 +12754,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -12730,7 +12775,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -12741,7 +12786,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -12802,7 +12847,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -12817,87 +12862,86 @@ "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "" + "example": "" }, "redirect_uri": { "type": "string", "description": "Redirect URI where visitor will be redirected after authorization, whether successful or not.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "response_type": { "type": "string", "description": "OAuth2 \/ OIDC response type. One of `code` (Authorization Code Flow), `id_token` (Implicit Flow, OIDC login only), or `code id_token` (Hybrid Flow).", "default": "", - "x-example": "" + "example": "" }, "scope": { "type": "string", "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`, `phone`.", "default": "", - "x-example": "" + "example": "" }, "state": { "type": "string", "description": "OAuth2 state. You receive this back in the redirect URI.", "default": "", - "x-example": "" + "example": "" }, "nonce": { "type": "string", "description": "OIDC nonce parameter to prevent replay attacks. Required when response_type includes `id_token`.", "default": "", - "x-example": "" + "example": "" }, "code_challenge": { "type": "string", "description": "PKCE code challenge. Required when OAuth2 app is public.", "default": "", - "x-example": "" + "example": "" }, "code_challenge_method": { "type": "string", "description": "PKCE code challenge method. Required when OAuth2 app is public.", "default": "", - "x-example": "s256" + "example": "s256" }, "prompt": { "type": "string", "description": "OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.", "default": "", - "x-example": "" + "example": "" }, "max_age": { "type": "integer", "description": "OIDC max_age paraleter for customization of consent screen. Maximum allowable elapsed time in seconds since the user last authenticated. If exceeded, re-authentication is required.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "authorization_details": { "type": "string", "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", "default": "", - "x-example": "" + "example": "" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "" + "example": "" }, "request_uri": { "type": "string", "description": "OAuth2 authorization request handle returned by the pushed authorization request endpoint.", "default": "", - "x-example": "" + "example": "" } } } @@ -12961,7 +13005,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -12976,31 +13020,30 @@ "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "" + "example": "" }, "scope": { "type": "string", "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`.", "default": "", - "x-example": "" + "example": "" }, "authorization_details": { "type": "string", "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", "default": "", - "x-example": "" + "example": "" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "" + "example": "" } } } @@ -13064,7 +13107,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -13078,7 +13121,7 @@ "user_code": { "type": "string", "description": "User code displayed on the device.", - "x-example": "" + "example": "" } }, "required": [ @@ -13145,7 +13188,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -13155,7 +13198,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -13211,7 +13254,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -13221,7 +13264,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -13232,7 +13275,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -13243,7 +13286,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -13255,7 +13298,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -13266,7 +13309,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -13277,7 +13320,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -13332,7 +13375,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -13347,38 +13390,38 @@ "type": "string", "description": "ID Token previously issued to the app, used as proof of the logout request. Required to end the session; signature and issuer are validated while expiry is ignored.", "default": "", - "x-example": "" + "example": "" }, "logout_hint": { "type": "string", "description": "Hint about the user that is logging out. Accepted for OIDC compatibility.", "default": "", - "x-example": "" + "example": "" }, "client_id": { "type": "string", "description": "OAuth2 client ID. When both `client_id` and `id_token_hint` are provided, they must identify the same app.", "default": "", - "x-example": "" + "example": "" }, "post_logout_redirect_uri": { "type": "string", "description": "URI to redirect the user to after logout. Must exactly match a URI registered in the app's `postLogoutRedirectUris`.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "state": { "type": "string", "description": "Opaque value passed back unchanged in the `state` query param of the post-logout redirect.", "default": "", - "x-example": "" + "example": "" }, "ui_locales": { "type": "string", "description": "Preferred languages for any logout UI, as space-separated BCP47 tags. Accepted for OIDC compatibility.", "default": "", - "x-example": "" + "example": "" } } } @@ -13442,7 +13485,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -13453,7 +13496,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -13465,7 +13508,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -13476,7 +13519,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -13539,7 +13582,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -13553,79 +13596,78 @@ "client_id": { "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", - "x-example": "" + "example": "" }, "redirect_uri": { "type": "string", "description": "Redirect URI where visitor will be redirected after authorization, whether successful or not.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "response_type": { "type": "string", "description": "OAuth2 \/ OIDC response type.", - "x-example": "code" + "example": "code" }, "scope": { "type": "string", "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`, `phone`.", "default": "", - "x-example": "" + "example": "" }, "state": { "type": "string", "description": "OAuth2 state. You receive this back in the redirect URI.", "default": "", - "x-example": "" + "example": "" }, "nonce": { "type": "string", "description": "OIDC nonce parameter to prevent replay attacks. Required when response_type includes `id_token`.", "default": "", - "x-example": "" + "example": "" }, "code_challenge": { "type": "string", "description": "PKCE code challenge. Required when OAuth2 app is public.", "default": "", - "x-example": "" + "example": "" }, "code_challenge_method": { "type": "string", "description": "PKCE code challenge method. Required when OAuth2 app is public.", "default": "", - "x-example": "s256" + "example": "s256" }, "prompt": { "type": "string", "description": "OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.", "default": "", - "x-example": "" + "example": "" }, "max_age": { "type": "integer", "description": "OIDC max_age parameter for customization of consent screen.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "authorization_details": { "type": "string", "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", "default": "", - "x-example": "" + "example": "" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -13694,7 +13736,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -13705,7 +13747,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -13717,7 +13759,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -13728,7 +13770,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -13791,7 +13833,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -13805,7 +13847,7 @@ "grant_id": { "type": "string", "description": "Grant ID made during authorization, provided to consent screen in URL search params.", - "x-example": "" + "example": "" } }, "required": [ @@ -13873,7 +13915,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -13887,25 +13929,25 @@ "token": { "type": "string", "description": "The access or refresh token to revoke.", - "x-example": "" + "example": "" }, "token_type_hint": { "type": "string", "description": "Type of token to revoke (access_token or refresh_token).", "default": "", - "x-example": "access_token" + "example": "access_token" }, "client_id": { "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "" + "example": "" }, "client_secret": { "type": "string", "description": "OAuth2 client secret. Required for confidential apps; omitted for public apps.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -13972,7 +14014,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -13986,62 +14028,61 @@ "grant_type": { "type": "string", "description": "OAuth2 grant type. Can be one of: `authorization_code`, `refresh_token`, `urn:ietf:params:oauth:grant-type:device_code`.", - "x-example": "" + "example": "" }, "code": { "type": "string", "description": "Authorization code to be exchanged for access and refresh tokens. Required for `authorization_code` grant type.", "default": "", - "x-example": "" + "example": "" }, "refresh_token": { "type": "string", "description": "Refresh token to be exchanged for a new access and refresh tokens. Required for `refresh_token` grant type.", "default": "", - "x-example": "" + "example": "" }, "device_code": { "type": "string", "description": "Device code obtained from the device authorization endpoint. Required for `urn:ietf:params:oauth:grant-type:device_code` grant type.", "default": "", - "x-example": "" + "example": "" }, "client_id": { "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "" + "example": "" }, "client_secret": { "type": "string", "description": "OAuth2 client secret. Required for confidential apps.", "default": "", - "x-example": "" + "example": "" }, "code_verifier": { "type": "string", "description": "PKCE code verifier. Required for public apps.", "default": "", - "x-example": "" + "example": "" }, "redirect_uri": { "type": "string", "description": "Redirect URI. Required for `authorization_code` grant type.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -14121,7 +14162,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -14184,13 +14225,13 @@ "appId": { "type": "string", "description": "Application unique ID.", - "x-example": "" + "example": "" }, "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -14257,7 +14298,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14317,7 +14358,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14331,8 +14372,8 @@ "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -14390,7 +14431,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14516,7 +14557,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -14528,7 +14569,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -14592,7 +14633,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14681,7 +14722,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14695,17 +14736,19 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "" + "example": "" }, "status": { "type": "string", "description": "Presence status.", - "x-example": "" + "example": "" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -14713,14 +14756,14 @@ "expiresAt": { "type": "string", "description": "Presence expiry datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime" }, "metadata": { "type": "object", "description": "Presence metadata object.", "default": [], - "x-example": "{}" + "example": {} } }, "required": [ @@ -14814,7 +14857,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14828,29 +14871,31 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "" + "example": "" }, "status": { "type": "string", "description": "Presence status.", - "x-example": "" + "example": "" }, "expiresAt": { "type": "string", "description": "Presence expiry datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime" }, "metadata": { "type": "object", "description": "Presence metadata object.", "default": {}, - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -14859,7 +14904,7 @@ "type": "boolean", "description": "When true, purge cached responses used by list presences endpoint.", "default": false, - "x-example": false + "example": false } } } @@ -14915,7 +14960,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14978,7 +15023,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15001,7 +15046,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -15012,7 +15057,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -15074,7 +15119,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -15088,7 +15133,7 @@ "fileId": { "type": "string", "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-upload-id": true, "x-appwrite": { "idGenerator": "ID.unique" @@ -15097,23 +15142,23 @@ "file": { "type": "string", "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "x-example": null, "format": "binary" }, "permissions": { "type": "array", "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "folder": { "type": "string", "description": "Virtual folder to place the file in, for example \"photos\/2026\". Nest folders with `\/`. Defaults to the bucket root.", - "default": "", - "x-example": null + "default": "" } }, "required": [ @@ -15182,7 +15227,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15192,7 +15237,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -15253,7 +15298,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15263,7 +15308,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -15277,16 +15322,18 @@ "name": { "type": "string", "description": "File name.", - "x-example": "" + "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true } } } @@ -15342,7 +15389,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15352,7 +15399,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -15418,7 +15465,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15428,7 +15475,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15438,7 +15485,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -15505,7 +15552,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15515,7 +15562,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15526,7 +15573,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -15538,7 +15585,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -15549,7 +15596,7 @@ "required": false, "schema": { "type": "string", - "x-example": "center", + "example": "center", "enum": [ "center", "top-left", @@ -15584,7 +15631,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -15596,7 +15643,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -15618,7 +15665,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -15630,7 +15677,7 @@ "schema": { "type": "number", "format": "float", - "x-example": 0, + "example": 0, "default": 1 }, "in": "query" @@ -15642,7 +15689,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -360, + "example": -360, "default": 0 }, "in": "query" @@ -15663,7 +15710,7 @@ "required": false, "schema": { "type": "string", - "x-example": "jpg", + "example": "jpg", "enum": [ "jpg", "jpeg", @@ -15692,7 +15739,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -15759,7 +15806,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15769,7 +15816,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15779,7 +15826,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -15916,7 +15963,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -15985,7 +16032,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16049,7 +16096,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16064,13 +16111,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -16129,7 +16176,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16195,7 +16242,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16210,7 +16257,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "", + "tableId": "", + "rowId": "", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -16281,7 +16338,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16291,7 +16348,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16314,7 +16371,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -16324,7 +16381,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -16336,7 +16393,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -16434,7 +16491,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16444,7 +16501,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16458,7 +16515,7 @@ "rowId": { "type": "string", "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -16467,22 +16524,29 @@ "type": "object", "description": "Row data as JSON object.", "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "rows": { "type": "array", "description": "Array of rows data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -16490,8 +16554,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } }, "required": [ @@ -16563,7 +16627,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16573,7 +16637,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16583,7 +16647,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16606,7 +16670,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -16702,7 +16766,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16712,7 +16776,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16722,7 +16786,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16737,22 +16801,30 @@ "type": "object", "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -16818,7 +16890,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16828,7 +16900,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16838,7 +16910,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16853,22 +16925,30 @@ "type": "object", "description": "Row data as JSON object. Include only columns 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}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -16927,7 +17007,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16937,7 +17017,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16947,7 +17027,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16957,7 +17037,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -17023,7 +17103,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17033,7 +17113,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17043,7 +17123,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17067,21 +17147,19 @@ "type": "number", "description": "Value to increment the column by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "min": { "type": "number", "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -17149,7 +17227,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17159,7 +17237,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17169,7 +17247,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17193,21 +17271,19 @@ "type": "number", "description": "Value to increment the column by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "max": { "type": "number", "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -17285,7 +17361,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -17296,7 +17372,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -17360,7 +17436,7 @@ "teamId": { "type": "string", "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -17368,7 +17444,7 @@ "name": { "type": "string", "description": "Team name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "roles": { "type": "array", @@ -17376,7 +17452,6 @@ "default": [ "owner" ], - "x-example": null, "items": { "type": "string" } @@ -17448,7 +17523,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -17509,7 +17584,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -17523,7 +17598,7 @@ "name": { "type": "string", "description": "New team name. Max length: 128 chars.", - "x-example": "" + "example": "" } }, "required": [ @@ -17582,7 +17657,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -17644,7 +17719,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17667,7 +17742,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -17728,7 +17803,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -17742,13 +17817,13 @@ "appId": { "type": "string", "description": "Application unique ID.", - "x-example": "" + "example": "" }, "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -17815,7 +17890,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17825,7 +17900,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -17885,7 +17960,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17895,7 +17970,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -17909,8 +17984,8 @@ "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -17968,7 +18043,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17978,7 +18053,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18041,7 +18116,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18064,7 +18139,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -18075,7 +18150,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -18137,7 +18212,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18152,26 +18227,25 @@ "type": "string", "description": "Email of the new team member.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "userId": { "type": "string", "description": "ID of the user to be added to a team.", "default": "", - "x-example": "" + "example": "" }, "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "roles": { "type": "array", "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", - "x-example": null, "items": { "type": "string" } @@ -18180,14 +18254,14 @@ "type": "string", "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "name": { "type": "string", "description": "Name of the new team member. Max length: 128 chars.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -18255,7 +18329,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18265,7 +18339,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18326,7 +18400,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18336,7 +18410,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18350,7 +18424,6 @@ "roles": { "type": "array", "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", - "x-example": null, "items": { "type": "string" } @@ -18412,7 +18485,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18422,7 +18495,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18485,7 +18558,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18495,7 +18568,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18509,12 +18582,12 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "" + "example": "" }, "secret": { "type": "string", "description": "Secret key.", - "x-example": "" + "example": "" } }, "required": [ @@ -18583,7 +18656,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18644,7 +18717,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18659,7 +18732,7 @@ "type": "object", "description": "Prefs key-value JSON object.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -18794,7 +18867,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -18860,7 +18933,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18921,7 +18994,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18936,13 +19009,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -18998,7 +19071,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -19061,7 +19134,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -19076,7 +19149,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "", + "collectionId": "", + "documentId": "", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -19144,7 +19227,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19154,7 +19237,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19177,7 +19260,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -19187,7 +19270,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -19199,7 +19282,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -19293,7 +19376,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19303,7 +19386,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -19317,7 +19400,7 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -19326,12 +19409,24 @@ "type": "object", "description": "Document data as JSON object.", "default": {}, - "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" + "example": { + "embeddings": [ + 0.12, + -0.55, + 0.88, + 1.02 + ], + "metadata": { + "key": "value" + } + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -19340,7 +19435,6 @@ "type": "array", "description": "Array of documents data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -19348,7 +19442,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } }, "required": [ @@ -19417,7 +19511,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19427,7 +19521,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -19442,7 +19536,6 @@ "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" } @@ -19450,19 +19543,19 @@ "transactionId": { "type": "string", "description": "Transaction ID to read uncommitted changes within the transaction.", - "x-example": "" + "example": "" }, "total": { "type": "boolean", "description": "When set to false, the total count returned will be 0 and will not be calculated.", "default": true, - "x-example": false + "example": false }, "ttl": { "type": "integer", "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } } @@ -19528,7 +19621,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19538,7 +19631,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19548,7 +19641,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19571,7 +19664,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -19664,7 +19757,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19674,7 +19767,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19687,7 +19780,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "" + "example": "" }, "in": "path" } @@ -19702,12 +19795,14 @@ "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -19715,7 +19810,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -19778,7 +19873,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19788,7 +19883,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19798,7 +19893,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -19813,12 +19908,14 @@ "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -19826,7 +19923,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -19882,7 +19979,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19892,7 +19989,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19902,7 +19999,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19912,7 +20009,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -20024,7 +20121,7 @@ "description": "Any", "type": "object", "additionalProperties": true, - "example": [] + "example": {} }, "rowList": { "description": "Rows List", @@ -20033,16 +20130,15 @@ "total": { "type": "integer", "description": "Total number of rows that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "rows": { "type": "array", "description": "List of rows.", "items": { "$ref": "#\/components\/schemas\/row" - }, - "x-example": "" + } } }, "required": [ @@ -20061,16 +20157,15 @@ "total": { "type": "integer", "description": "Total number of documents that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "documents": { "type": "array", "description": "List of documents.", "items": { "$ref": "#\/components\/schemas\/document" - }, - "x-example": "" + } } }, "required": [ @@ -20089,16 +20184,15 @@ "total": { "type": "integer", "description": "Total number of presences that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "presences": { "type": "array", "description": "List of presences.", "items": { "$ref": "#\/components\/schemas\/presence" - }, - "x-example": "" + } } }, "required": [ @@ -20117,16 +20211,15 @@ "total": { "type": "integer", "description": "Total number of sessions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "sessions": { "type": "array", "description": "List of sessions.", "items": { "$ref": "#\/components\/schemas\/session" - }, - "x-example": "" + } } }, "required": [ @@ -20145,16 +20238,15 @@ "total": { "type": "integer", "description": "Total number of identities that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "identities": { "type": "array", "description": "List of identities.", "items": { "$ref": "#\/components\/schemas\/identity" - }, - "x-example": "" + } } }, "required": [ @@ -20173,16 +20265,15 @@ "total": { "type": "integer", "description": "Total number of logs that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "logs": { "type": "array", "description": "List of logs.", "items": { "$ref": "#\/components\/schemas\/log" - }, - "x-example": "" + } } }, "required": [ @@ -20201,16 +20292,15 @@ "total": { "type": "integer", "description": "Total number of files that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "files": { "type": "array", "description": "List of files.", "items": { "$ref": "#\/components\/schemas\/file" - }, - "x-example": "" + } } }, "required": [ @@ -20229,16 +20319,15 @@ "total": { "type": "integer", "description": "Total number of teams that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "teams": { "type": "array", "description": "List of teams.", "items": { "$ref": "#\/components\/schemas\/team" - }, - "x-example": "" + } } }, "required": [ @@ -20257,16 +20346,15 @@ "total": { "type": "integer", "description": "Total number of memberships that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "memberships": { "type": "array", "description": "List of memberships.", "items": { "$ref": "#\/components\/schemas\/membership" - }, - "x-example": "" + } } }, "required": [ @@ -20285,16 +20373,15 @@ "total": { "type": "integer", "description": "Total number of executions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "executions": { "type": "array", "description": "List of executions.", "items": { "$ref": "#\/components\/schemas\/execution" - }, - "x-example": "" + } } }, "required": [ @@ -20313,16 +20400,15 @@ "total": { "type": "integer", "description": "Total number of countries that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "countries": { "type": "array", "description": "List of countries.", "items": { "$ref": "#\/components\/schemas\/country" - }, - "x-example": "" + } } }, "required": [ @@ -20341,16 +20427,15 @@ "total": { "type": "integer", "description": "Total number of continents that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "continents": { "type": "array", "description": "List of continents.", "items": { "$ref": "#\/components\/schemas\/continent" - }, - "x-example": "" + } } }, "required": [ @@ -20369,16 +20454,15 @@ "total": { "type": "integer", "description": "Total number of languages that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "languages": { "type": "array", "description": "List of languages.", "items": { "$ref": "#\/components\/schemas\/language" - }, - "x-example": "" + } } }, "required": [ @@ -20397,16 +20481,15 @@ "total": { "type": "integer", "description": "Total number of currencies that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "currencies": { "type": "array", "description": "List of currencies.", "items": { "$ref": "#\/components\/schemas\/currency" - }, - "x-example": "" + } } }, "required": [ @@ -20425,16 +20508,15 @@ "total": { "type": "integer", "description": "Total number of phones that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "phones": { "type": "array", "description": "List of phones.", "items": { "$ref": "#\/components\/schemas\/phone" - }, - "x-example": "" + } } }, "required": [ @@ -20453,16 +20535,15 @@ "total": { "type": "integer", "description": "Total number of localeCodes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "localeCodes": { "type": "array", "description": "List of localeCodes.", "items": { "$ref": "#\/components\/schemas\/localeCode" - }, - "x-example": "" + } } }, "required": [ @@ -20481,16 +20562,15 @@ "total": { "type": "integer", "description": "Total number of transactions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "transactions": { "type": "array", "description": "List of transactions.", "items": { "$ref": "#\/components\/schemas\/transaction" - }, - "x-example": "" + } } }, "required": [ @@ -20509,35 +20589,35 @@ "$id": { "type": "string", "description": "Row ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$sequence": { "type": "string", "description": "Row sequence ID.", - "x-example": "1", - "readOnly": true + "readOnly": true, + "example": "1" }, "$tableId": { "type": "string", "description": "Table ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$createdAt": { "type": "string", "description": "Row creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Row update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -20545,7 +20625,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] } @@ -20579,35 +20659,35 @@ "$id": { "type": "string", "description": "Document ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$sequence": { "type": "string", "description": "Document sequence ID.", - "x-example": "1", - "readOnly": true + "readOnly": true, + "example": "1" }, "$collectionId": { "type": "string", "description": "Collection ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$createdAt": { "type": "string", "description": "Document creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Document update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -20615,7 +20695,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] } @@ -20654,17 +20734,17 @@ "$id": { "type": "string", "description": "Presence ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Presence creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Presence update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -20672,37 +20752,37 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "userId": { "type": "string", "description": "User ID.", - "x-example": "674af8f3e12a5f9ac0be" + "example": "674af8f3e12a5f9ac0be" }, "status": { "type": "string", "description": "Presence status.", - "x-example": "online", + "example": "online", "nullable": true }, "source": { "type": "string", "description": "Presence source.", - "x-example": "HTTP" + "example": "HTTP" }, "expiresAt": { "type": "string", "description": "Presence expiry date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "metadata": { "type": "object", "additionalProperties": true, "description": "Presence metadata.", - "x-example": { + "example": { "key": "value" } } @@ -20738,112 +20818,112 @@ "event": { "type": "string", "description": "Event name.", - "x-example": "account.sessions.create" + "example": "account.sessions.create" }, "userId": { "type": "string", "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "userEmail": { "type": "string", "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "userName": { "type": "string", "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "John Doe" + "example": "John Doe" }, "mode": { "type": "string", "description": "API mode when event triggered.", - "x-example": "admin" + "example": "admin" }, "userType": { "type": "string", "description": "User type who triggered the audit log. Possible values: user, admin, guest, hidden, keyProject, keyAccount, keyOrganization.", - "x-example": "user" + "example": "user" }, "ip": { "type": "string", "description": "IP session in use when the session was created.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "time": { "type": "string", "description": "Log creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "osCode": { "type": "string", "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "example": "Mac" }, "osName": { "type": "string", "description": "Operating system name.", - "x-example": "Mac" + "example": "Mac" }, "osVersion": { "type": "string", "description": "Operating system version.", - "x-example": "Mac" + "example": "Mac" }, "clientType": { "type": "string", "description": "Client type.", - "x-example": "browser" + "example": "browser" }, "clientCode": { "type": "string", "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "example": "CM" }, "clientName": { "type": "string", "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "example": "Chrome Mobile iOS" }, "clientVersion": { "type": "string", "description": "Client version.", - "x-example": "84.0" + "example": "84.0" }, "clientEngine": { "type": "string", "description": "Client engine name.", - "x-example": "WebKit" + "example": "WebKit" }, "clientEngineVersion": { "type": "string", "description": "Client engine name.", - "x-example": "605.1.15" + "example": "605.1.15" }, "deviceName": { "type": "string", "description": "Device name.", - "x-example": "smartphone" + "example": "smartphone" }, "deviceBrand": { "type": "string", "description": "Device brand name.", - "x-example": "Google" + "example": "Google" }, "deviceModel": { "type": "string", "description": "Device model name.", - "x-example": "Nexus 5" + "example": "Nexus 5" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" }, "countryName": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" } }, "required": [ @@ -20902,39 +20982,39 @@ "$id": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "User creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "User update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "User name.", - "x-example": "John Doe" + "example": "John Doe" }, "password": { "type": "string", "description": "Hashed user password.", - "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", "nullable": true }, "hash": { "type": "string", "description": "Password hashing algorithm.", - "x-example": "argon2", + "example": "argon2", "nullable": true }, "hashOptions": { "type": "object", "description": "Password hashing algorithm configuration.", - "x-example": {}, + "example": {}, "allOf": [ { "oneOf": [ @@ -20979,12 +21059,12 @@ "registration": { "type": "string", "description": "User registration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "status": { "type": "boolean", "description": "User status. Pass `true` for enabled and `false` for disabled.", - "x-example": true + "example": true }, "labels": { "type": "array", @@ -20992,74 +21072,74 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "vip" ] }, "passwordUpdate": { "type": "string", "description": "Password update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "email": { "type": "string", "description": "User email address.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "phone": { "type": "string", "description": "User phone number in E.164 format.", - "x-example": "+4930901820" + "example": "+4930901820" }, "emailVerification": { "type": "boolean", "description": "Email verification status.", - "x-example": true + "example": true }, "emailCanonical": { "type": "string", "description": "Canonical form of the user email address.", - "x-example": "john@appwrite.io", + "example": "john@appwrite.io", "nullable": true }, "emailIsFree": { "type": "boolean", "description": "Whether the user email is from a free email provider.", - "x-example": true, + "example": true, "nullable": true }, "emailIsDisposable": { "type": "boolean", "description": "Whether the user email is from a disposable email provider.", - "x-example": false, + "example": false, "nullable": true }, "emailIsCorporate": { "type": "boolean", "description": "Whether the user email is from a corporate domain.", - "x-example": true, + "example": true, "nullable": true }, "emailIsCanonical": { "type": "boolean", "description": "Whether the user email is in its canonical form.", - "x-example": true, + "example": true, "nullable": true }, "phoneVerification": { "type": "boolean", "description": "Phone verification status.", - "x-example": true + "example": true }, "mfa": { "type": "boolean", "description": "Multi factor authentication status.", - "x-example": true + "example": true }, "prefs": { "type": "object", "description": "User preferences as a key-value object", - "x-example": { + "example": { "theme": "pink", "timezone": "UTC" }, @@ -21075,23 +21155,23 @@ "items": { "$ref": "#\/components\/schemas\/target" }, - "x-example": [] + "example": [] }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "impersonator": { "type": "boolean", "description": "Whether the user can impersonate other users.", - "x-example": false, + "example": false, "nullable": true }, "impersonatorUserId": { "type": "string", "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", - "x-example": "5e5ea5c16897e", + "example": "5e5ea5c16897e", "nullable": true } }, @@ -21154,7 +21234,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "md5" + "example": "md5" } }, "required": [ @@ -21171,7 +21251,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "sha" + "example": "sha" } }, "required": [ @@ -21188,7 +21268,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "phpass" + "example": "phpass" } }, "required": [ @@ -21205,7 +21285,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "bcrypt" + "example": "bcrypt" } }, "required": [ @@ -21222,31 +21302,31 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "scrypt" + "example": "scrypt" }, "costCpu": { "type": "integer", "description": "CPU complexity of computed hash.", - "x-example": 8, - "format": "int32" + "format": "int32", + "example": 8 }, "costMemory": { "type": "integer", "description": "Memory complexity of computed hash.", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "costParallel": { "type": "integer", "description": "Parallelization of computed hash.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "length": { "type": "integer", "description": "Length used to compute hash.", - "x-example": 64, - "format": "int32" + "format": "int32", + "example": 64 } }, "required": [ @@ -21271,22 +21351,22 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "scryptMod" + "example": "scryptMod" }, "salt": { "type": "string", "description": "Salt used to compute hash.", - "x-example": "UxLMreBr6tYyjQ==" + "example": "UxLMreBr6tYyjQ==" }, "saltSeparator": { "type": "string", "description": "Separator used to compute hash.", - "x-example": "Bw==" + "example": "Bw==" }, "signerKey": { "type": "string", "description": "Key used to compute hash.", - "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + "example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" } }, "required": [ @@ -21309,25 +21389,25 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "argon2" + "example": "argon2" }, "memoryCost": { "type": "integer", "description": "Memory used to compute hash.", - "x-example": 65536, - "format": "int32" + "format": "int32", + "example": 65536 }, "timeCost": { "type": "integer", "description": "Amount of time consumed to compute hash", - "x-example": 4, - "format": "int32" + "format": "int32", + "example": 4 }, "threads": { "type": "integer", "description": "Number of threads used to compute hash.", - "x-example": 3, - "format": "int32" + "format": "int32", + "example": 3 } }, "required": [ @@ -21360,132 +21440,132 @@ "$id": { "type": "string", "description": "Session ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Session creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Session update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "expire": { "type": "string", "description": "Session expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "provider": { "type": "string", "description": "Session Provider.", - "x-example": "email" + "example": "email" }, "providerUid": { "type": "string", "description": "Session Provider User ID.", - "x-example": "user@example.com" + "example": "user@example.com" }, "providerAccessToken": { "type": "string", "description": "Session Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, "providerAccessTokenExpiry": { "type": "string", "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "providerRefreshToken": { "type": "string", "description": "Session Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, "ip": { "type": "string", "description": "IP in use when the session was created.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "osCode": { "type": "string", "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "example": "Mac" }, "osName": { "type": "string", "description": "Operating system name.", - "x-example": "Mac" + "example": "Mac" }, "osVersion": { "type": "string", "description": "Operating system version.", - "x-example": "Mac" + "example": "Mac" }, "clientType": { "type": "string", "description": "Client type.", - "x-example": "browser" + "example": "browser" }, "clientCode": { "type": "string", "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "example": "CM" }, "clientName": { "type": "string", "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "example": "Chrome Mobile iOS" }, "clientVersion": { "type": "string", "description": "Client version.", - "x-example": "84.0" + "example": "84.0" }, "clientEngine": { "type": "string", "description": "Client engine name.", - "x-example": "WebKit" + "example": "WebKit" }, "clientEngineVersion": { "type": "string", "description": "Client engine name.", - "x-example": "605.1.15" + "example": "605.1.15" }, "deviceName": { "type": "string", "description": "Device name.", - "x-example": "smartphone" + "example": "smartphone" }, "deviceBrand": { "type": "string", "description": "Device brand name.", - "x-example": "Google" + "example": "Google" }, "deviceModel": { "type": "string", "description": "Device model name.", - "x-example": "Nexus 5" + "example": "Nexus 5" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" }, "countryName": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" }, "current": { "type": "boolean", "description": "Returns true if this the current user session.", - "x-example": true + "example": true }, "factors": { "type": "array", @@ -21493,19 +21573,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "email" ] }, "secret": { "type": "string", "description": "Secret used to authenticate the user. Only included if the request was made with an API key", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "mfaUpdatedAt": { "type": "string", "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -21580,52 +21660,52 @@ "$id": { "type": "string", "description": "Identity ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Identity creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Identity update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "provider": { "type": "string", "description": "Identity Provider.", - "x-example": "email" + "example": "email" }, "providerUid": { "type": "string", "description": "ID of the User in the Identity Provider.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "providerEmail": { "type": "string", "description": "Email of the User in the Identity Provider.", - "x-example": "user@example.com" + "example": "user@example.com" }, "providerAccessToken": { "type": "string", "description": "Identity Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, "providerAccessTokenExpiry": { "type": "string", "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "providerRefreshToken": { "type": "string", "description": "Identity Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" } }, "required": [ @@ -21660,32 +21740,32 @@ "$id": { "type": "string", "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8" }, "secret": { "type": "string", "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "example": "" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "phrase": { "type": "string", "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", - "x-example": "Golden Fox" + "example": "Golden Fox" } }, "required": [ @@ -21712,7 +21792,7 @@ "jwt": { "type": "string", "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" } }, "required": [ @@ -21729,104 +21809,104 @@ "ip": { "type": "string", "description": "User IP address.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "countryCode": { "type": "string", "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", - "x-example": "US" + "example": "US" }, "country": { "type": "string", "description": "Country name. This field support localization.", - "x-example": "United States" + "example": "United States" }, "continentCode": { "type": "string", "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", - "x-example": "NA" + "example": "NA" }, "continent": { "type": "string", "description": "Continent name. This field support localization.", - "x-example": "North America" + "example": "North America" }, "eu": { "type": "boolean", "description": "True if country is part of the European Union.", - "x-example": false + "example": false }, "currency": { "type": "string", "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", - "x-example": "USD" + "example": "USD" }, "city": { "type": "string", "description": "City", - "x-example": "Kathmandu", + "example": "Kathmandu", "nullable": true }, "timeZone": { "type": "string", "description": "Name of timezone", - "x-example": "Asia\/Kathmandu", + "example": "Asia\/Kathmandu", "nullable": true }, "postalCode": { "type": "string", "description": "Postal code", - "x-example": "44600", + "example": "44600", "nullable": true }, "latitude": { "type": "number", "description": "Latitude", - "x-example": "82.345", "format": "double", + "example": 82.345, "nullable": true }, "longitude": { "type": "number", "description": "Longitude", - "x-example": "82.345", "format": "double", + "example": 82.345, "nullable": true }, "autonomousSystemNumber": { "type": "string", "description": "Autonomous System Number (ASN) of the IP", - "x-example": "15169", + "example": "15169", "nullable": true }, "autonomousSystemOrganization": { "type": "string", "description": "Organization that owns the ASN", - "x-example": "GOOGLE", + "example": "GOOGLE", "nullable": true }, "isp": { "type": "string", "description": "Internet service provider of the IP", - "x-example": "Google", + "example": "Google", "nullable": true }, "connectionType": { "type": "string", "description": "Connection type of the IP (e.g. cable, cellular, corporate)", - "x-example": "cable", + "example": "cable", "nullable": true }, "connectionUsageType": { "type": "string", "description": "User type classification of the IP (e.g. residential, business, hosting)", - "x-example": "residential", + "example": "residential", "nullable": true }, "connectionOrganization": { "type": "string", "description": "Registered organization of the IP", - "x-example": "Google LLC", + "example": "Google LLC", "nullable": true } }, @@ -21867,12 +21947,12 @@ "code": { "type": "string", "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", - "x-example": "en-us" + "example": "en-us" }, "name": { "type": "string", "description": "Locale name", - "x-example": "US" + "example": "US" } }, "required": [ @@ -21891,22 +21971,22 @@ "$id": { "type": "string", "description": "File ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "bucketId": { "type": "string", "description": "Bucket ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "File creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "File update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -21914,68 +21994,68 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "name": { "type": "string", "description": "File name.", - "x-example": "Pink.png" + "example": "Pink.png" }, "folder": { "type": "string", "description": "Virtual folder containing the file, with a trailing slash. Empty for the bucket root.", - "x-example": "photos\/2026\/" + "example": "photos\/2026\/" }, "key": { "type": "string", "description": "Full virtual path of the file: the folder followed by the file name.", - "x-example": "photos\/2026\/Pink.png" + "example": "photos\/2026\/Pink.png" }, "signature": { "type": "string", "description": "File MD5 signature.", - "x-example": "5d529fd02b544198ae075bd57c1762bb" + "example": "5d529fd02b544198ae075bd57c1762bb" }, "mimeType": { "type": "string", "description": "File mime type.", - "x-example": "image\/png" + "example": "image\/png" }, "sizeOriginal": { "type": "integer", "description": "File original size in bytes.", - "x-example": 17890, - "format": "int32" + "format": "int32", + "example": 17890 }, "sizeActual": { "type": "integer", "description": "File actual stored size in bytes after compression and\/or encryption.", - "x-example": 12345, - "format": "int32" + "format": "int32", + "example": 12345 }, "chunksTotal": { "type": "integer", "description": "Total number of chunks available", - "x-example": 17890, - "format": "int32" + "format": "int32", + "example": 17890 }, "chunksUploaded": { "type": "integer", "description": "Total number of chunks uploaded", - "x-example": 17890, - "format": "int32" + "format": "int32", + "example": 17890 }, "encryption": { "type": "boolean", "description": "Whether file contents are encrypted at rest.", - "x-example": true + "example": true }, "compression": { "type": "string", "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" + "example": "gzip" } }, "required": [ @@ -22024,33 +22104,33 @@ "$id": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Team creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Team update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Team name.", - "x-example": "VIP" + "example": "VIP" }, "total": { "type": "integer", "description": "Total number of team members.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "prefs": { "type": "object", "description": "Team preferences as a key-value object", - "x-example": { + "example": { "theme": "pink", "timezone": "UTC" }, @@ -22088,72 +22168,72 @@ "$id": { "type": "string", "description": "Membership ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Membership creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Membership update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userName": { "type": "string", "description": "User name. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "John Doe" + "example": "John Doe" }, "userEmail": { "type": "string", "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "userPhone": { "type": "string", "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "+1 555 555 5555" + "example": "+1 555 555 5555" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "teamName": { "type": "string", "description": "Team name.", - "x-example": "VIP" + "example": "VIP" }, "invited": { "type": "string", "description": "Date, the user has been invited to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "joined": { "type": "string", "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "confirm": { "type": "boolean", "description": "User confirmation status, true if the user has joined the team or false otherwise.", - "x-example": false + "example": false }, "mfa": { "type": "boolean", "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", - "x-example": false + "example": false }, "userAccessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "roles": { "type": "array", @@ -22161,7 +22241,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "owner" ] } @@ -22210,17 +22290,17 @@ "$id": { "type": "string", "description": "Execution ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Execution creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Execution update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -22228,19 +22308,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "any" ] }, "resourceId": { "type": "string", "description": "Function or site ID.", - "x-example": "5e5ea6g16897e" + "example": "5e5ea6g16897e" }, "resourceType": { "type": "string", "description": "Execution resource type.", - "x-example": "functions", + "example": "functions", "enum": [ "functions", "sites" @@ -22249,12 +22329,12 @@ "deploymentId": { "type": "string", "description": "Deployment ID used to create the execution.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "trigger": { "type": "string", "description": "The trigger that caused the resource to execute. Possible values can be: `http`, `schedule`, or `event`.", - "x-example": "http", + "example": "http", "enum": [ "http", "schedule", @@ -22264,7 +22344,7 @@ "status": { "type": "string", "description": "The status of the resource execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", - "x-example": "processing", + "example": "processing", "enum": [ "waiting", "processing", @@ -22276,12 +22356,12 @@ "requestMethod": { "type": "string", "description": "HTTP request method type.", - "x-example": "GET" + "example": "GET" }, "requestPath": { "type": "string", "description": "HTTP request path and query.", - "x-example": "\/articles?id=5" + "example": "\/articles?id=5" }, "requestHeaders": { "type": "array", @@ -22289,7 +22369,7 @@ "items": { "$ref": "#\/components\/schemas\/headers" }, - "x-example": [ + "example": [ { "Content-Type": "application\/json" } @@ -22298,13 +22378,13 @@ "responseStatusCode": { "type": "integer", "description": "HTTP response status code.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 }, "responseBody": { "type": "string", "description": "HTTP response body. This will return empty unless execution is created as synchronous.", - "x-example": "" + "example": "" }, "responseHeaders": { "type": "array", @@ -22312,7 +22392,7 @@ "items": { "$ref": "#\/components\/schemas\/headers" }, - "x-example": [ + "example": [ { "Content-Type": "application\/json" } @@ -22321,23 +22401,23 @@ "logs": { "type": "string", "description": "Resource logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "example": "" }, "errors": { "type": "string", "description": "Resource errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "example": "" }, "duration": { "type": "number", "description": "Resource(function\/site) execution duration in seconds.", - "x-example": 0.4, - "format": "double" + "format": "double", + "example": 0.4 }, "scheduledAt": { "type": "string", "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -22400,12 +22480,12 @@ "name": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" }, "code": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" } }, "required": [ @@ -22424,12 +22504,12 @@ "name": { "type": "string", "description": "Continent name.", - "x-example": "Europe" + "example": "Europe" }, "code": { "type": "string", "description": "Continent two letter code.", - "x-example": "EU" + "example": "EU" } }, "required": [ @@ -22448,17 +22528,17 @@ "name": { "type": "string", "description": "Language name.", - "x-example": "Italian" + "example": "Italian" }, "code": { "type": "string", "description": "Language two-character ISO 639-1 codes.", - "x-example": "it" + "example": "it" }, "nativeName": { "type": "string", "description": "Language native name.", - "x-example": "Italiano" + "example": "Italiano" } }, "required": [ @@ -22479,39 +22559,39 @@ "symbol": { "type": "string", "description": "Currency symbol.", - "x-example": "$" + "example": "$" }, "name": { "type": "string", "description": "Currency name.", - "x-example": "US dollar" + "example": "US dollar" }, "symbolNative": { "type": "string", "description": "Currency native symbol.", - "x-example": "$" + "example": "$" }, "decimalDigits": { "type": "integer", "description": "Number of decimal digits.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "rounding": { "type": "number", "description": "Currency digit rounding.", - "x-example": 0, - "format": "double" + "format": "double", + "example": 0 }, "code": { "type": "string", "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.", - "x-example": "USD" + "example": "USD" }, "namePlural": { "type": "string", "description": "Currency plural name", - "x-example": "US dollars" + "example": "US dollars" } }, "required": [ @@ -22540,17 +22620,17 @@ "code": { "type": "string", "description": "Phone code.", - "x-example": "+1" + "example": "+1" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" }, "countryName": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" } }, "required": [ @@ -22571,12 +22651,12 @@ "name": { "type": "string", "description": "Header name.", - "x-example": "Content-Type" + "example": "Content-Type" }, "value": { "type": "string", "description": "Header value.", - "x-example": "application\/json" + "example": "application\/json" } }, "required": [ @@ -22595,22 +22675,22 @@ "$id": { "type": "string", "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -22636,7 +22716,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "a3kf0-s0cl2", "s0co1-as98s" ] @@ -22659,12 +22739,12 @@ "secret": { "type": "string", "description": "Secret token used for TOTP factor.", - "x-example": "[SHARED_SECRET]" + "example": "[SHARED_SECRET]" }, "uri": { "type": "string", "description": "URI for authenticator apps.", - "x-example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" + "example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" } }, "required": [ @@ -22683,27 +22763,27 @@ "totp": { "type": "boolean", "description": "Can TOTP be used for MFA challenge for this account.", - "x-example": true + "example": true }, "phone": { "type": "boolean", "description": "Can phone (SMS) be used for MFA challenge for this account.", - "x-example": true + "example": true }, "email": { "type": "boolean", "description": "Can email be used for MFA challenge for this account.", - "x-example": true + "example": true }, "recoveryCode": { "type": "boolean", "description": "Can recovery code be used for MFA challenge for this account.", - "x-example": true + "example": true }, "custom": { "type": "boolean", "description": "Can custom factor be used for MFA challenge for this account.", - "x-example": true + "example": true } }, "required": [ @@ -22728,33 +22808,33 @@ "$id": { "type": "string", "description": "Transaction ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Transaction creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Transaction update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "status": { "type": "string", "description": "Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.", - "x-example": "pending" + "example": "pending" }, "operations": { "type": "integer", "description": "Number of operations in the transaction.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "expiresAt": { "type": "string", "description": "Expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -22781,27 +22861,27 @@ "$id": { "type": "string", "description": "Subscriber ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Subscriber creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Subscriber update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "targetId": { "type": "string", "description": "Target ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "target": { "type": "object", "description": "Target.", - "x-example": { + "example": { "$id": "259125845563242502", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", @@ -22820,22 +22900,22 @@ "userId": { "type": "string", "description": "Topic ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userName": { "type": "string", "description": "User Name.", - "x-example": "Aegon Targaryen" + "example": "Aegon Targaryen" }, "topicId": { "type": "string", "description": "Topic ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "providerType": { "type": "string", "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email" + "example": "email" } }, "required": [ @@ -22877,48 +22957,48 @@ "$id": { "type": "string", "description": "Target ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Target creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Target update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Target Name.", - "x-example": "Apple iPhone 12" + "example": "Apple iPhone 12" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "providerId": { "type": "string", "description": "Provider ID.", - "x-example": "259125845563242502", + "example": "259125845563242502", "nullable": true }, "providerType": { "type": "string", "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email" + "example": "email" }, "identifier": { "type": "string", "description": "The target identifier.", - "x-example": "token" + "example": "token" }, "expired": { "type": "boolean", "description": "Is the target expired.", - "x-example": false + "example": false } }, "required": [ @@ -22950,47 +23030,47 @@ "$id": { "type": "string", "description": "App ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "App creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "App update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Application name.", - "x-example": "My Application" + "example": "My Application" }, "description": { "type": "string", "description": "Application description shown to users during OAuth2 consent.", - "x-example": "Connect your workspace to My Application." + "example": "Connect your workspace to My Application." }, "clientUri": { "type": "string", "description": "Application homepage URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "logoUri": { "type": "string", "description": "Application logo URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/logo.png" + "example": "https:\/\/example.com\/logo.png" }, "privacyPolicyUrl": { "type": "string", "description": "Application privacy policy URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/privacy" + "example": "https:\/\/example.com\/privacy" }, "termsUrl": { "type": "string", "description": "Application terms of service URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/terms" + "example": "https:\/\/example.com\/terms" }, "contacts": { "type": "array", @@ -22998,14 +23078,14 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "support@example.com" ] }, "tagline": { "type": "string", "description": "Application tagline shown to users during OAuth2 consent.", - "x-example": "Automate your workspace." + "example": "Automate your workspace." }, "tags": { "type": "array", @@ -23013,7 +23093,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "productivity", "automation" ] @@ -23024,7 +23104,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "featured" ] }, @@ -23034,19 +23114,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/example.com\/screenshot.png" ] }, "supportUrl": { "type": "string", "description": "Application support URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/support" + "example": "https:\/\/example.com\/support" }, "dataDeletionUrl": { "type": "string", "description": "Application data deletion URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/data-deletion" + "example": "https:\/\/example.com\/data-deletion" }, "redirectUris": { "type": "array", @@ -23054,7 +23134,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/example.com\/callback" ] }, @@ -23064,34 +23144,34 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/example.com\/logged-out" ] }, "enabled": { "type": "boolean", "description": "Whether the app is enabled or not.", - "x-example": true + "example": true }, "type": { "type": "string", "description": "OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.", - "x-example": "confidential" + "example": "confidential" }, "deviceFlow": { "type": "boolean", "description": "Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).", - "x-example": false + "example": false }, "teamId": { "type": "string", "description": "ID of team that owns the application, if owned by team. Otherwise, user ID will be used.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userId": { "type": "string", "description": "ID of user who owns the application, if owned by user. Otherwise, team ID will be used.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "installationScopes": { "type": "array", @@ -23099,14 +23179,14 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "organization:organization.read" ] }, "installationRedirectUrl": { "type": "string", "description": "URL users are redirected to after creating or updating an installation of this application. Empty for no redirect.", - "x-example": "https:\/\/example.com\/setup" + "example": "https:\/\/example.com\/setup" }, "secrets": { "type": "array", @@ -23114,7 +23194,7 @@ "items": { "$ref": "#\/components\/schemas\/appSecret" }, - "x-example": [] + "example": [] } }, "required": [ @@ -23196,47 +23276,47 @@ "$id": { "type": "string", "description": "Secret ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Secret creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Secret update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "Application ID this secret belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "secret": { "type": "string", "description": "Always empty. The application client secret is returned only once, in the response of the createSecret method.", - "x-example": "" + "example": "" }, "hint": { "type": "string", "description": "Last few characters of the client secret, used to help identify it.", - "x-example": "f5c6c7" + "example": "f5c6c7" }, "createdById": { "type": "string", "description": "ID of the user who created the secret.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the secret.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -23269,47 +23349,47 @@ "$id": { "type": "string", "description": "Secret ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Secret creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Secret update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "Application ID this secret belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "secret": { "type": "string", "description": "Application client secret. Returned only when the secret is created; subsequent reads always return an empty value.", - "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, "hint": { "type": "string", "description": "Last few characters of the client secret, used to help identify it.", - "x-example": "f5c6c7" + "example": "f5c6c7" }, "createdById": { "type": "string", "description": "ID of the user who created the secret.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the secret.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -23342,27 +23422,27 @@ "value": { "type": "string", "description": "Scope value as requested by apps.", - "x-example": "organization:organization.read" + "example": "organization:organization.read" }, "description": { "type": "string", "description": "Human-readable description of what the scope grants.", - "x-example": "Access to read the organization" + "example": "Access to read the organization" }, "type": { "type": "string", "description": "What the scope grants access to. One of `account`, `project`, or `organization`. Only `project` and `organization` scopes are installable.", - "x-example": "organization" + "example": "organization" }, "category": { "type": "string", "description": "Scope category, used to group scopes on consent and installation screens.", - "x-example": "Organization" + "example": "Organization" }, "deprecated": { "type": "boolean", "description": "Whether the scope is deprecated. Deprecated scopes can still be requested but should not be offered for new grants.", - "x-example": false + "example": false } }, "required": [ @@ -23387,27 +23467,27 @@ "$id": { "type": "string", "description": "Installation ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Installation creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Installation update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "ID of the installed application.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "teamId": { "type": "string", "description": "ID of the team the application is installed on.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "scopes": { "type": "array", @@ -23415,15 +23495,17 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "organization:organization.read" ] }, "authorizationDetails": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "Authorization details granted to the application. Rich authorization request (RFC 9396) style entries; the Appwrite Console stores authorized project IDs here.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "type": "project", "identifiers": [ @@ -23435,17 +23517,17 @@ "createdById": { "type": "string", "description": "ID of the user who created the installation.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the installation.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time an access token was last issued for the installation in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -23489,47 +23571,47 @@ "$id": { "type": "string", "description": "App key ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "App key creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "App key update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "Application ID this app key belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "secret": { "type": "string", "description": "App key secret.", - "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, "hint": { "type": "string", "description": "Last few characters of the app key secret, used to help identify it.", - "x-example": "f5c6c7" + "example": "f5c6c7" }, "createdById": { "type": "string", "description": "ID of the user who created the app key.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the app key.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time the app key was last used for authentication in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -23562,12 +23644,12 @@ "grantId": { "type": "string", "description": "OAuth2 grant ID. Set when the user must give explicit consent; pass it to the approve or reject endpoint. Empty when a redirect URL is returned instead.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "redirectUrl": { "type": "string", "description": "URL the end user should be redirected to when the flow can complete without consent. Empty when consent is still required.", - "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + "example": "https:\/\/example.com\/callback?code=abcde&state=fghij" } }, "required": [ @@ -23586,7 +23668,7 @@ "redirectUrl": { "type": "string", "description": "URL the end user should be redirected to after the grant is approved, carrying the authorization `code` and\/or `id_token` along with the original `state`.", - "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + "example": "https:\/\/example.com\/callback?code=abcde&state=fghij" } }, "required": [ @@ -23603,7 +23685,7 @@ "redirectUrl": { "type": "string", "description": "URL the end user should be redirected to after the grant is rejected, carrying an `access_denied` error.", - "x-example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + "example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" } }, "required": [ @@ -23620,27 +23702,27 @@ "$id": { "type": "string", "description": "Grant ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Grant creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Grant update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "ID of the user the grant belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "appId": { "type": "string", "description": "ID of the OAuth2 client (app) the grant was requested for.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "scopes": { "type": "array", @@ -23648,7 +23730,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "openid", "email", "profile" @@ -23660,35 +23742,35 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/api.example.com\/" ] }, "authorizationDetails": { "type": "string", "description": "Requested authorization_details the user is being asked to consent to, as a JSON string. Each entry has a `type` plus project-defined fields.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, "prompt": { "type": "string", "description": "OIDC prompt directive the consent screen should honor. Space-separated list of: login, consent, select_account.", - "x-example": "login" + "example": "login" }, "redirectUri": { "type": "string", "description": "Redirect URI the user will be sent to after the flow completes.", - "x-example": "https:\/\/example.com\/callback" + "example": "https:\/\/example.com\/callback" }, "authTime": { "type": "integer", "description": "Unix timestamp of when the user last authenticated.", - "x-example": 1592981250, - "format": "int32" + "format": "int32", + "example": 1592981250 }, "expire": { "type": "string", "description": "Grant expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -23733,34 +23815,34 @@ "device_code": { "type": "string", "description": "Device verification code used by the client to poll the token endpoint.", - "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, "user_code": { "type": "string", "description": "Short code the end user enters on the verification page.", - "x-example": "ABCD-EFGH" + "example": "ABCD-EFGH" }, "verification_uri": { "type": "string", "description": "URL where the end user enters the user code.", - "x-example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device" + "example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device" }, "verification_uri_complete": { "type": "string", "description": "Verification URL with the user code prefilled as a query parameter.", - "x-example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device?user_code=ABCD-EFGH" + "example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device?user_code=ABCD-EFGH" }, "expires_in": { "type": "integer", "description": "Lifetime of the device code and user code in seconds.", - "x-example": 900, - "format": "int32" + "format": "int32", + "example": 900 }, "interval": { "type": "integer", "description": "Minimum polling interval for the token endpoint in seconds.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 } }, "required": [ @@ -23787,13 +23869,13 @@ "request_uri": { "type": "string", "description": "Authorization request handle to pass to the authorize endpoint.", - "x-example": "urn:appwrite:oauth2:request:5e5ea5c16897e" + "example": "urn:appwrite:oauth2:request:5e5ea5c16897e" }, "expires_in": { "type": "integer", "description": "Lifetime of the authorization request handle in seconds.", - "x-example": 600, - "format": "int32" + "format": "int32", + "example": 600 } }, "required": [ @@ -23812,39 +23894,39 @@ "access_token": { "type": "string", "description": "OAuth2 access token.", - "x-example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..." + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..." }, "token_type": { "type": "string", "description": "OAuth2 token type.", - "x-example": "Bearer" + "example": "Bearer" }, "expires_in": { "type": "integer", "description": "Access token lifetime in seconds.", - "x-example": 3600, - "format": "int32" + "format": "int32", + "example": 3600 }, "refresh_token": { "type": "string", "description": "OAuth2 refresh token.", - "x-example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." }, "scope": { "type": "string", "description": "Space-separated scopes granted to the access token.", - "x-example": "openid email profile" + "example": "openid email profile" }, "authorization_details": { "type": "string", "description": "Granted RFC 9396 authorization details as a JSON string.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\"]}]", + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\"]}]", "nullable": true }, "id_token": { "type": "string", "description": "OpenID Connect ID token. Returned when the `openid` scope is granted.", - "x-example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", "nullable": true } }, @@ -23872,32 +23954,32 @@ "$id": { "type": "string", "description": "Consent ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Consent creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Consent update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "ID of the user the consent belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "appId": { "type": "string", "description": "ID of the registered app the consent was given to. Empty for URL-form (CIMD) clients.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "cimdUrl": { "type": "string", "description": "Client ID metadata document URL of the client the consent was given to. Empty for registered apps.", - "x-example": "https:\/\/example.com\/.well-known\/client-metadata.json" + "example": "https:\/\/example.com\/.well-known\/client-metadata.json" }, "scopes": { "type": "array", @@ -23905,7 +23987,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "openid", "email", "profile" @@ -23917,19 +23999,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/api.example.com\/" ] }, "authorizationDetails": { "type": "string", "description": "Authorization details the user consented to, as a JSON string. Each entry has a `type` plus project-defined fields.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, "expire": { "type": "string", "description": "Consent expiration time in ISO 8601 format. Empty when the consent has no token-bound expiry yet.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -23970,37 +24052,37 @@ "$id": { "type": "string", "description": "Token family ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Token update date in ISO 8601 format. Refreshing the token family updates this.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "consentId": { "type": "string", "description": "ID of the consent the token family was issued under.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userId": { "type": "string", "description": "ID of the user the token family belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "appId": { "type": "string", "description": "ID of the registered app the token family was issued to. Empty for URL-form (CIMD) clients.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "cimdUrl": { "type": "string", "description": "Client ID metadata document URL of the client the token family was issued to. Empty for registered apps.", - "x-example": "https:\/\/example.com\/.well-known\/client-metadata.json" + "example": "https:\/\/example.com\/.well-known\/client-metadata.json" }, "scopes": { "type": "array", @@ -24008,7 +24090,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "openid", "email", "profile" @@ -24020,19 +24102,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/api.example.com\/" ] }, "authorizationDetails": { "type": "string", "description": "Authorization details granted on the token family, as a JSON string. Each entry has a `type` plus project-defined fields.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, "expire": { "type": "string", "description": "Expiration time of the current access token of this family in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -24075,17 +24157,17 @@ "$id": { "type": "string", "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "region": { "type": "string", "description": "Region ID the project is deployed in.", - "x-example": "fra" + "example": "fra" }, "endpoint": { "type": "string", "description": "API endpoint of the region the project is deployed in. Empty when the region has no public hostname configured.", - "x-example": "https:\/\/fra.cloud.appwrite.io\/v1" + "example": "https:\/\/fra.cloud.appwrite.io\/v1" } }, "required": [ @@ -24106,7 +24188,7 @@ "$id": { "type": "string", "description": "Organization ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" } }, "required": [ @@ -24123,16 +24205,15 @@ "total": { "type": "integer", "description": "Total number of projects that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "projects": { "type": "array", "description": "List of projects.", "items": { "$ref": "#\/components\/schemas\/oauth2Project" - }, - "x-example": "" + } } }, "required": [ @@ -24151,16 +24232,15 @@ "total": { "type": "integer", "description": "Total number of organizations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "organizations": { "type": "array", "description": "List of organizations.", "items": { "$ref": "#\/components\/schemas\/oauth2Organization" - }, - "x-example": "" + } } }, "required": [ @@ -24179,16 +24259,15 @@ "total": { "type": "integer", "description": "Total number of consents that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "consents": { "type": "array", "description": "List of consents.", "items": { "$ref": "#\/components\/schemas\/oauth2Consent" - }, - "x-example": "" + } } }, "required": [ @@ -24207,16 +24286,15 @@ "total": { "type": "integer", "description": "Total number of tokens that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "tokens": { "type": "array", "description": "List of tokens.", "items": { "$ref": "#\/components\/schemas\/oauth2ConsentToken" - }, - "x-example": "" + } } }, "required": [ @@ -24235,16 +24313,15 @@ "total": { "type": "integer", "description": "Total number of apps that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "apps": { "type": "array", "description": "List of apps.", "items": { "$ref": "#\/components\/schemas\/app" - }, - "x-example": "" + } } }, "required": [ @@ -24263,16 +24340,15 @@ "total": { "type": "integer", "description": "Total number of secrets that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "secrets": { "type": "array", "description": "List of secrets.", "items": { "$ref": "#\/components\/schemas\/appSecret" - }, - "x-example": "" + } } }, "required": [ @@ -24291,16 +24367,15 @@ "total": { "type": "integer", "description": "Total number of scopes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "scopes": { "type": "array", "description": "List of scopes.", "items": { "$ref": "#\/components\/schemas\/appScope" - }, - "x-example": "" + } } }, "required": [ @@ -24319,16 +24394,15 @@ "total": { "type": "integer", "description": "Total number of installations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "installations": { "type": "array", "description": "List of installations.", "items": { "$ref": "#\/components\/schemas\/appInstallation" - }, - "x-example": "" + } } }, "required": [ @@ -24347,16 +24421,15 @@ "total": { "type": "integer", "description": "Total number of keys that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "keys": { "type": "array", "description": "List of keys.", "items": { "$ref": "#\/components\/schemas\/appKey" - }, - "x-example": "" + } } }, "required": [ 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 cac2bb72c..8ba2ca910 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 @@ -139,7 +139,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -147,20 +147,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -326,35 +326,35 @@ "country": { "type": "string", "description": "Country", - "x-example": "" + "example": "" }, "city": { "type": "string", "description": "City", - "x-example": "" + "example": "" }, "streetAddress": { "type": "string", "description": "Street address", - "x-example": "" + "example": "" }, "addressLine2": { "type": "string", "description": "Address line 2", "default": "", - "x-example": "" + "example": "" }, "state": { "type": "string", "description": "State or province", "default": "", - "x-example": "" + "example": "" }, "postalCode": { "type": "string", "description": "Postal code", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -420,7 +420,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -477,7 +477,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -491,35 +491,35 @@ "country": { "type": "string", "description": "Country", - "x-example": "" + "example": "" }, "city": { "type": "string", "description": "City", - "x-example": "" + "example": "" }, "streetAddress": { "type": "string", "description": "Street address", - "x-example": "" + "example": "" }, "addressLine2": { "type": "string", "description": "Address line 2", "default": "", - "x-example": "" + "example": "" }, "state": { "type": "string", "description": "State or province", "default": "", - "x-example": "" + "example": "" }, "postalCode": { "type": "string", "description": "Postal code", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -579,7 +579,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -654,7 +654,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -717,7 +717,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -773,7 +773,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -835,7 +835,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -858,7 +858,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -921,7 +921,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -931,7 +931,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -987,7 +987,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -997,7 +997,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -1056,7 +1056,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -1121,13 +1121,13 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -1210,7 +1210,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -1267,7 +1267,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -1393,7 +1393,7 @@ "type": "integer", "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", "default": 900, - "x-example": 0, + "example": 0, "format": "int32" } } @@ -1454,7 +1454,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -1513,12 +1513,11 @@ "name": { "type": "string", "description": "Key name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -1537,9 +1536,9 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -1603,7 +1602,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -1659,7 +1658,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -1673,12 +1672,11 @@ "name": { "type": "string", "description": "Key name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -1697,9 +1695,9 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -1757,7 +1755,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -1833,7 +1831,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -1899,7 +1897,7 @@ "mfa": { "type": "boolean", "description": "Enable or disable MFA.", - "x-example": false + "example": false } }, "required": [ @@ -2023,7 +2021,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -2151,7 +2149,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -2172,7 +2170,7 @@ "otp": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -2285,7 +2283,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -2413,7 +2411,7 @@ "factor": { "type": "string", "description": "Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`, `custom`.", - "x-example": "email", + "example": "email", "enum": [ "email", "phone", @@ -2556,12 +2554,12 @@ "challengeId": { "type": "string", "description": "ID of the challenge.", - "x-example": "" + "example": "" }, "otp": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -3024,7 +3022,7 @@ "name": { "type": "string", "description": "User name. Max length: 128 chars.", - "x-example": "" + "example": "" } }, "required": [ @@ -3094,14 +3092,14 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" }, "oldPassword": { "type": "string", "description": "Current user password. Max length: 256 chars.", "default": "", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -3273,7 +3271,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -3330,7 +3328,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -3344,19 +3342,19 @@ "expiryMonth": { "type": "integer", "description": "Payment expiry month", - "x-example": 1, + "example": 1, "format": "int32" }, "expiryYear": { "type": "integer", "description": "Expiry year", - "x-example": 2026, + "example": 2026, "format": "int32" }, "state": { "type": "string", "description": "State of the payment method country", - "x-example": "" + "example": "" } }, "required": [ @@ -3415,7 +3413,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -3474,7 +3472,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -3488,18 +3486,18 @@ "providerMethodId": { "type": "string", "description": "Payment method ID from the payment provider", - "x-example": "" + "example": "" }, "name": { "type": "string", "description": "Name in the payment method", - "x-example": "" + "example": "" }, "state": { "type": "string", "description": "State of the payment method country", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } }, "required": [ @@ -3564,7 +3562,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -3629,13 +3627,13 @@ "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "password": { "type": "string", "description": "User password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -3757,7 +3755,11 @@ "type": "object", "description": "Prefs key-value JSON object.", "default": {}, - "x-example": "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}" + "example": { + "language": "en", + "timezone": "UTC", + "darkTheme": true + } } }, "required": [ @@ -3830,13 +3832,13 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "url": { "type": "string", "description": "URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" } }, @@ -3906,17 +3908,17 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "" + "example": "" }, "secret": { "type": "string", "description": "Valid reset token.", - "x-example": "" + "example": "" }, "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -4133,13 +4135,13 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -4215,7 +4217,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -4223,7 +4225,7 @@ "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -4293,7 +4295,7 @@ "required": true, "schema": { "type": "string", - "x-example": "amazon", + "example": "amazon", "enum": [ "amazon", "apple", @@ -4397,7 +4399,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -4409,7 +4411,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -4492,7 +4494,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -4500,7 +4502,7 @@ "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -4571,7 +4573,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -4579,7 +4581,7 @@ "secret": { "type": "string", "description": "Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.", - "x-example": "" + "example": "" } }, "required": [ @@ -4648,7 +4650,7 @@ "required": true, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "current" }, "in": "path" @@ -4710,7 +4712,7 @@ "required": true, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "current" }, "in": "path" @@ -4765,7 +4767,7 @@ "required": true, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "current" }, "in": "path" @@ -4880,7 +4882,7 @@ "targetId": { "type": "string", "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -4888,13 +4890,13 @@ "identifier": { "type": "string", "description": "The target identifier (token, email, phone etc.)", - "x-example": "" + "example": "" }, "providerId": { "type": "string", "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -4961,7 +4963,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -4975,7 +4977,7 @@ "identifier": { "type": "string", "description": "The target identifier (token, email, phone etc.)", - "x-example": "" + "example": "" } }, "required": [ @@ -5032,7 +5034,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -5100,7 +5102,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -5108,14 +5110,14 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "phrase": { "type": "boolean", "description": "Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -5189,7 +5191,7 @@ "userId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -5197,21 +5199,21 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "url": { "type": "string", "description": "URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "phrase": { "type": "boolean", "description": "Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -5281,7 +5283,7 @@ "required": true, "schema": { "type": "string", - "x-example": "amazon", + "example": "amazon", "enum": [ "amazon", "apple", @@ -5385,7 +5387,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -5397,7 +5399,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -5479,7 +5481,7 @@ "userId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -5487,7 +5489,7 @@ "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" } }, @@ -5611,7 +5613,7 @@ "url": { "type": "string", "description": "URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" } }, @@ -5736,12 +5738,12 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "" + "example": "" }, "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -5864,12 +5866,12 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "" + "example": "" }, "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "" + "example": "" } }, "required": [ @@ -6000,7 +6002,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -6121,7 +6123,7 @@ "linkId": { "type": "string", "description": "Link ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. This ID is the shareable referral code.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -6130,7 +6132,7 @@ "type": "string", "description": "Link name. Max length: 128 chars.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -6197,7 +6199,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "" + "example": "" }, "in": "path" } @@ -6253,7 +6255,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "" + "example": "" }, "in": "path" } @@ -6436,7 +6438,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -6450,12 +6452,12 @@ "status": { "type": "string", "description": "New reward status. Use `claimed` to claim the reward as organization credits.", - "x-example": "claimed" + "example": "claimed" }, "organizationId": { "type": "string", "description": "Organization ID to apply credits to when claiming.", - "x-example": "" + "example": "" } }, "required": [ @@ -6537,7 +6539,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -6601,7 +6603,7 @@ "appId": { "type": "string", "description": "Application ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -6609,47 +6611,46 @@ "name": { "type": "string", "description": "Application name.", - "x-example": "" + "example": "" }, "description": { "type": "string", "description": "Application description shown to users during OAuth2 consent.", "default": "", - "x-example": "" + "example": "" }, "clientUri": { "type": "string", "description": "Application homepage URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "logoUri": { "type": "string", "description": "Application logo URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "privacyPolicyUrl": { "type": "string", "description": "Application privacy policy URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "termsUrl": { "type": "string", "description": "Application terms of service URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "contacts": { "type": "array", "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -6658,13 +6659,12 @@ "type": "string", "description": "Application tagline shown to users during OAuth2 consent.", "default": "", - "x-example": "" + "example": "" }, "tags": { "type": "array", "description": "Application tags shown to users during OAuth2 consent. Maximum of 100 tags are allowed, each up to 64 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -6673,7 +6673,6 @@ "type": "array", "description": "Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -6682,20 +6681,19 @@ "type": "string", "description": "Application support URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "dataDeletionUrl": { "type": "string", "description": "Application data deletion URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "redirectUris": { "type": "array", "description": "Redirect URIs. Each must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI (e.g. com.example.app:\/oauth), and must not contain a fragment.", - "x-example": null, "items": { "type": "string" } @@ -6704,7 +6702,6 @@ "type": "array", "description": "Post-logout redirect URIs for OpenID Connect RP-Initiated Logout. Each must be an https URL, an http loopback URL, or a private-use scheme URI, and must not contain a fragment. After ending the user session, the logout endpoint only redirects to URIs in this list.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -6713,25 +6710,25 @@ "type": "boolean", "description": "Is application enabled?", "default": true, - "x-example": false + "example": false }, "type": { "type": "string", "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", "default": "confidential", - "x-example": "public" + "example": "public" }, "deviceFlow": { "type": "boolean", "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", "default": false, - "x-example": false + "example": false }, "teamId": { "type": "string", "description": "Team unique ID.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -6903,7 +6900,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -6964,7 +6961,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -6978,47 +6975,46 @@ "name": { "type": "string", "description": "Application name.", - "x-example": "" + "example": "" }, "description": { "type": "string", "description": "Application description shown to users during OAuth2 consent.", "default": "", - "x-example": "" + "example": "" }, "clientUri": { "type": "string", "description": "Application homepage URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "logoUri": { "type": "string", "description": "Application logo URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "privacyPolicyUrl": { "type": "string", "description": "Application privacy policy URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "termsUrl": { "type": "string", "description": "Application terms of service URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "contacts": { "type": "array", "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -7027,13 +7023,12 @@ "type": "string", "description": "Application tagline shown to users during OAuth2 consent.", "default": "", - "x-example": "" + "example": "" }, "tags": { "type": "array", "description": "Application tags shown to users during OAuth2 consent. Maximum of 100 tags are allowed, each up to 64 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -7042,7 +7037,6 @@ "type": "array", "description": "Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -7051,27 +7045,26 @@ "type": "string", "description": "Application support URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "dataDeletionUrl": { "type": "string", "description": "Application data deletion URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "enabled": { "type": "boolean", "description": "Is application enabled?", "default": true, - "x-example": false + "example": false }, "redirectUris": { "type": "array", "description": "Redirect URIs. Each must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI (e.g. com.example.app:\/oauth), and must not contain a fragment.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -7080,7 +7073,6 @@ "type": "array", "description": "Post-logout redirect URIs for OpenID Connect RP-Initiated Logout. Each must be an https URL, an http loopback URL, or a private-use scheme URI, and must not contain a fragment. After ending the user session, the logout endpoint only redirects to URIs in this list.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -7089,19 +7081,18 @@ "type": "string", "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", "default": "confidential", - "x-example": "public" + "example": "public" }, "deviceFlow": { "type": "boolean", "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", "default": false, - "x-example": false + "example": false }, "installationScopes": { "type": "array", "description": "Scopes the application requests when installed on a team. Only scopes allowed by the project's OAuth2 server installation scopes configuration are accepted; use the list installation scopes endpoint to discover available values. Maximum of 100 scopes are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -7110,7 +7101,7 @@ "type": "string", "description": "URL users are redirected to after creating or updating an installation of this application. Must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI, and must not contain a fragment. Leave empty for no redirect.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" } }, @@ -7173,7 +7164,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -7239,7 +7230,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -7262,7 +7253,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -7329,7 +7320,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -7339,7 +7330,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -7396,7 +7387,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -7406,7 +7397,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -7472,7 +7463,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -7482,7 +7473,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -7545,7 +7536,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -7568,7 +7559,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -7630,7 +7621,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -7693,7 +7684,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -7703,7 +7694,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -7760,7 +7751,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -7770,7 +7761,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -7830,7 +7821,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -7844,7 +7835,6 @@ "labels": { "type": "array", "description": "Array of application labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", - "x-example": null, "items": { "type": "string" } @@ -7915,7 +7905,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -7938,7 +7928,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -8000,7 +7990,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -8063,7 +8053,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -8073,7 +8063,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -8130,7 +8120,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -8140,7 +8130,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -8203,7 +8193,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -8217,7 +8207,7 @@ "teamId": { "type": "string", "description": "Team ID of the team to transfer application to.", - "x-example": "" + "example": "" } }, "required": [ @@ -8281,7 +8271,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -8348,7 +8338,7 @@ "required": true, "schema": { "type": "string", - "x-example": "aa", + "example": "aa", "enum": [ "aa", "an", @@ -8392,7 +8382,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -8404,7 +8394,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -8416,7 +8406,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -8484,7 +8474,7 @@ "required": true, "schema": { "type": "string", - "x-example": "amex", + "example": "amex", "enum": [ "amex", "argencard", @@ -8534,7 +8524,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -8546,7 +8536,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -8558,7 +8548,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -8627,7 +8617,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" } @@ -8694,7 +8684,7 @@ "required": true, "schema": { "type": "string", - "x-example": "af", + "example": "af", "enum": [ "af", "ao", @@ -9100,7 +9090,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -9112,7 +9102,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -9124,7 +9114,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -9193,7 +9183,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" }, @@ -9204,7 +9194,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 400 }, "in": "query" @@ -9216,7 +9206,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 400 }, "in": "query" @@ -9284,7 +9274,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -9296,7 +9286,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 500 }, "in": "query" @@ -9308,7 +9298,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 500 }, "in": "query" @@ -9386,7 +9376,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -9397,7 +9387,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 400 }, "in": "query" @@ -9409,7 +9399,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 1 }, "in": "query" @@ -9420,7 +9410,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": false }, "in": "query" @@ -9489,7 +9479,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" }, @@ -9500,7 +9490,10 @@ "schema": { "type": "object", "default": [], - "x-example": "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}" + "example": { + "Authorization": "Bearer token123", + "X-Custom-Header": "value" + } }, "in": "query" }, @@ -9511,7 +9504,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "1920", + "example": 1920, "default": 1280 }, "in": "query" @@ -9523,7 +9516,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "1080", + "example": 1080, "default": 720 }, "in": "query" @@ -9535,7 +9528,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "2", + "example": 2, "default": 1 }, "in": "query" @@ -9546,7 +9539,7 @@ "required": false, "schema": { "type": "string", - "x-example": "dark", + "example": "dark", "enum": [ "light", "dark" @@ -9566,7 +9559,7 @@ "required": false, "schema": { "type": "string", - "x-example": "Mozilla\/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit\/605.1.15", + "example": "Mozilla\/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit\/605.1.15", "default": "" }, "in": "query" @@ -9577,7 +9570,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": "true", + "example": true, "default": false }, "in": "query" @@ -9588,7 +9581,7 @@ "required": false, "schema": { "type": "string", - "x-example": "en-US", + "example": "en-US", "default": "" }, "in": "query" @@ -9599,7 +9592,7 @@ "required": false, "schema": { "type": "string", - "x-example": "America\/New_York", + "example": "America\/New_York", "enum": [ "africa\/abidjan", "africa\/accra", @@ -10453,7 +10446,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "37.7749", + "example": 37.7749, "default": 0 }, "in": "query" @@ -10465,7 +10458,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "-122.4194", + "example": -122.4194, "default": 0 }, "in": "query" @@ -10477,7 +10470,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "100", + "example": 100, "default": 0 }, "in": "query" @@ -10488,7 +10481,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": "true", + "example": true, "default": false }, "in": "query" @@ -10547,7 +10540,10 @@ "xr-spatial-tracking" ] }, - "x-example": "[\"geolocation\",\"notifications\"]", + "example": [ + "geolocation", + "notifications" + ], "default": [] }, "in": "query" @@ -10559,7 +10555,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "3", + "example": 3, "default": 0 }, "in": "query" @@ -10571,7 +10567,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "800", + "example": 800, "default": 0 }, "in": "query" @@ -10583,7 +10579,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "600", + "example": 600, "default": 0 }, "in": "query" @@ -10595,7 +10591,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "85", + "example": 85, "default": -1 }, "in": "query" @@ -10606,7 +10602,7 @@ "required": false, "schema": { "type": "string", - "x-example": "jpeg", + "example": "jpeg", "enum": [ "jpg", "jpeg", @@ -10750,7 +10746,6 @@ "services": { "type": "array", "description": "Array of services to backup", - "x-example": null, "items": { "type": "string", "enum": [ @@ -10777,8 +10772,8 @@ "resourceId": { "type": "string", "description": "Resource ID. When set, only this single resource will be backed up.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } }, "required": [ @@ -10844,7 +10839,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -10902,7 +10897,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "" + "example": "" }, "in": "path" } @@ -11033,7 +11028,7 @@ "policyId": { "type": "string", "description": "Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -11042,12 +11037,11 @@ "type": "string", "description": "Policy name. Max length: 128 chars.", "default": "", - "x-example": "" + "example": "" }, "services": { "type": "array", "description": "Array of services to backup", - "x-example": null, "items": { "type": "string", "enum": [ @@ -11074,25 +11068,24 @@ "resourceId": { "type": "string", "description": "Resource ID. When set, only this single resource will be backed up.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "enabled": { "type": "boolean", "description": "Is policy enabled? When set to 'disabled', no backups will be taken", "default": true, - "x-example": false + "example": false }, "retention": { "type": "integer", "description": "Days to keep backups before deletion", - "x-example": 1, + "example": 1, "format": "int32" }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." } }, "required": [ @@ -11164,7 +11157,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -11226,7 +11219,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -11240,26 +11233,25 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "retention": { "type": "integer", "description": "Days to keep backups before deletion", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "schedule": { "type": "string", - "description": "Cron expression", - "x-example": null + "description": "Cron expression" }, "enabled": { "type": "boolean", "description": "Is Backup enabled? When set to 'disabled', No backup will be taken", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -11322,7 +11314,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "" + "example": "" }, "in": "path" } @@ -11385,12 +11377,11 @@ "archiveId": { "type": "string", "description": "Backup archive ID to restore", - "x-example": "" + "example": "" }, "services": { "type": "array", "description": "Array of services to restore", - "x-example": null, "items": { "type": "string", "enum": [ @@ -11418,7 +11409,7 @@ "type": "string", "description": "Destination resource ID. Omit to restore the archived resource in place, or pass a different ID to restore alongside it as a new resource. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": "", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -11427,7 +11418,7 @@ "type": "string", "description": "Database name. Max length: 128 chars.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -11558,7 +11549,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -11619,7 +11610,7 @@ "prompt": { "type": "string", "description": "Prompt. A string containing questions asked to the AI assistant.", - "x-example": "" + "example": "" } }, "required": [ @@ -11683,7 +11674,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -11742,7 +11733,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -11814,7 +11805,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -11825,7 +11816,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -11931,7 +11922,7 @@ "required": false, "schema": { "type": "string", - "x-example": "appwrite", + "example": "appwrite", "enum": [ "appwrite", "imagine" @@ -12000,7 +11991,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -12106,7 +12097,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -12165,7 +12156,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -12263,7 +12254,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -12273,7 +12264,7 @@ "required": true, "schema": { "type": "string", - "x-example": "rules", + "example": "rules", "enum": [ "rules" ], @@ -12433,33 +12424,33 @@ "ref": { "type": "string", "description": "Ref param", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "referrer": { "type": "string", "description": "Referrer", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "utmSource": { "type": "string", "description": "Utm source", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "utmCampaign": { "type": "string", "description": "Utm campaign", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "utmMedium": { "type": "string", "description": "Utm medium", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -12520,7 +12511,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -12530,7 +12521,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -12540,7 +12531,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -12551,7 +12542,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 3 }, "in": "query" @@ -12563,7 +12554,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 7 }, "in": "query" @@ -12623,7 +12614,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -12633,7 +12624,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -12644,7 +12635,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 1 }, "in": "query" @@ -12656,7 +12647,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 4 }, "in": "query" @@ -12716,7 +12707,7 @@ "required": true, "schema": { "type": "string", - "x-example": "activities", + "example": "activities", "enum": [ "activities", "activityevents", @@ -12925,7 +12916,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -12935,7 +12926,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -12945,7 +12936,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -13003,7 +12994,7 @@ "required": true, "schema": { "type": "string", - "x-example": "verification", + "example": "verification", "enum": [ "verification", "magicSession", @@ -13032,7 +13023,7 @@ "required": false, "schema": { "type": "string", - "x-example": "af", + "example": "af", "enum": [ "af", "ar-ae", @@ -13452,7 +13443,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -13463,7 +13454,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -13561,7 +13552,7 @@ "databaseId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -13569,13 +13560,13 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "enabled": { "type": "boolean", "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -13721,7 +13712,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -13792,7 +13783,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -13858,7 +13849,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -13873,13 +13864,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -13940,7 +13931,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14008,7 +13999,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14023,7 +14014,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "", + "collectionId": "", + "documentId": "", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -14122,7 +14123,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14216,7 +14217,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14230,13 +14231,13 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "enabled": { "type": "boolean", "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false } } } @@ -14322,7 +14323,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14387,7 +14388,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -14410,7 +14411,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -14421,7 +14422,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -14485,7 +14486,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14499,7 +14500,7 @@ "collectionId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -14507,34 +14508,35 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "documentSecurity": { "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "attributes": { "type": "array", "description": "Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, varchar, text, mediumtext, longtext, integer, bigint, double, boolean, datetime, point, linestring, polygon, email, url, ip, enum), size (integer, required for string and varchar types), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -14543,7 +14545,6 @@ "type": "array", "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", "default": [], - "x-example": null, "items": { "type": "object" } @@ -14617,7 +14618,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -14627,7 +14628,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14690,7 +14691,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -14700,7 +14701,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14714,34 +14715,36 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "" + "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "documentSecurity": { "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "purge": { "type": "boolean", "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", "default": false, - "x-example": false + "example": false } } } @@ -14799,7 +14802,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -14809,7 +14812,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14874,7 +14877,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -14884,7 +14887,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -14907,7 +14910,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -14973,7 +14976,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -14983,7 +14986,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -14996,40 +14999,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -15100,7 +15099,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15110,7 +15109,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15133,34 +15132,30 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -15231,7 +15226,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15241,7 +15236,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -15254,25 +15249,24 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -15343,7 +15337,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15353,7 +15347,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15376,19 +15370,18 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "newKey": { "type": "string", "description": "New attribute key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -15459,7 +15452,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15469,7 +15462,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -15482,26 +15475,25 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -15572,7 +15564,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15582,7 +15574,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15605,20 +15597,19 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New attribute key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -15689,7 +15680,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15699,7 +15690,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -15712,26 +15703,25 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -15802,7 +15792,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15812,7 +15802,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15835,20 +15825,19 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -15919,7 +15908,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -15929,7 +15918,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -15942,13 +15931,11 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "elements": { "type": "array", "description": "Array of enum values.", - "x-example": null, "items": { "type": "string" } @@ -15956,19 +15943,19 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -16040,7 +16027,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16050,7 +16037,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16073,7 +16060,6 @@ "elements": { "type": "array", "description": "Updated list of enum values.", - "x-example": null, "items": { "type": "string" } @@ -16081,19 +16067,18 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -16165,7 +16150,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16175,7 +16160,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16188,40 +16173,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "number", "description": "Minimum value.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "max": { "type": "number", "description": "Maximum value.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "default": { "type": "number", "description": "Default value. Cannot be set when required.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -16292,7 +16273,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16302,7 +16283,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16325,34 +16306,30 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "number", "description": "Minimum value.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "max": { "type": "number", "description": "Maximum value.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "default": { "type": "number", "description": "Default value. Cannot be set when required.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -16423,7 +16400,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16433,7 +16410,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16446,40 +16423,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -16550,7 +16523,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16560,7 +16533,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16583,34 +16556,30 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -16681,7 +16650,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16691,7 +16660,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16704,25 +16673,23 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -16793,7 +16760,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16803,7 +16770,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16826,19 +16793,17 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -16909,7 +16874,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -16919,7 +16884,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -16932,18 +16897,30 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "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]]", + "example": [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ] + ], "items": { "type": "array", "items": { @@ -16951,7 +16928,7 @@ "format": "double" } }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -17022,7 +16999,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17032,7 +17009,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17055,12 +17032,25 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "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]]", + "example": [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ] + ], "items": { "type": "array", "items": { @@ -17068,13 +17058,12 @@ "format": "double" } }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New attribute key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -17144,7 +17133,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17154,7 +17143,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -17167,31 +17156,30 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "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 + "example": false } }, "required": [ @@ -17262,7 +17250,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17272,7 +17260,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17295,19 +17283,18 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -17378,7 +17365,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17388,7 +17375,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -17401,31 +17388,30 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "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 + "example": false } }, "required": [ @@ -17496,7 +17482,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17506,7 +17492,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17529,19 +17515,18 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -17612,7 +17597,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17622,7 +17607,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -17635,23 +17620,25 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "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]", + "example": [ + 1, + 2 + ], "items": { "type": "number", "format": "double" }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -17722,7 +17709,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17732,7 +17719,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17755,23 +17742,25 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "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]", + "example": [ + 1, + 2 + ], "items": { "type": "number", "format": "double" }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New attribute key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -17841,7 +17830,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17851,7 +17840,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -17864,18 +17853,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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]]]", + "example": [ + [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ], + [ + 1, + 2 + ] + ] + ], "items": { "type": "array", "items": { @@ -17886,7 +17893,7 @@ } } }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -17957,7 +17964,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17967,7 +17974,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -17990,12 +17997,31 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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]]]", + "example": [ + [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ], + [ + 1, + 2 + ] + ] + ], "items": { "type": "array", "items": { @@ -18006,13 +18032,12 @@ } } }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New attribute key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -18082,7 +18107,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18092,7 +18117,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18106,12 +18131,12 @@ "relatedCollectionId": { "type": "string", "description": "Related Collection ID.", - "x-example": "" + "example": "" }, "type": { "type": "string", "description": "Relationship type. Possible values are: oneToOne, oneToMany, manyToOne, manyToMany.", - "x-example": "oneToOne", + "example": "oneToOne", "enum": [ "oneToOne", "manyToOne", @@ -18130,25 +18155,23 @@ "type": "boolean", "description": "Is Two Way?", "default": false, - "x-example": false + "example": false }, "key": { "type": "string", "description": "Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true }, "twoWayKey": { "type": "string", "description": "Two Way Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true }, "onDelete": { "type": "string", "description": "Delete constraint. Possible values are: cascade, restrict, setNull.", "default": "restrict", - "x-example": "cascade", + "example": "cascade", "enum": [ "cascade", "restrict", @@ -18230,7 +18253,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18240,7 +18263,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18263,7 +18286,7 @@ "onDelete": { "type": "string", "description": "Delete constraint. Possible values are: cascade, restrict, setNull.", - "x-example": "cascade", + "example": "cascade", "enum": [ "cascade", "restrict", @@ -18279,8 +18302,7 @@ "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -18347,7 +18369,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18357,7 +18379,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18370,37 +18392,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "size": { "type": "integer", "description": "Attribute size for text attributes, in number of characters.", - "x-example": 1, + "example": 1, "format": "int32" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "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 + "example": false } }, "required": [ @@ -18472,7 +18493,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18482,7 +18503,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18505,26 +18526,25 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "size": { "type": "integer", "description": "Maximum size of the string attribute.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -18595,7 +18615,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18605,7 +18625,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18618,31 +18638,30 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "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 + "example": false } }, "required": [ @@ -18713,7 +18732,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18723,7 +18742,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18746,19 +18765,18 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -18829,7 +18847,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18839,7 +18857,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -18852,26 +18870,25 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -18942,7 +18959,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18952,7 +18969,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -18975,20 +18992,19 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -19059,7 +19075,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19069,7 +19085,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -19082,37 +19098,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "size": { "type": "integer", "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", - "x-example": 1, + "example": 1, "format": "int32" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "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 + "example": false } }, "required": [ @@ -19184,7 +19199,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19194,7 +19209,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19217,26 +19232,25 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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 + "example": "", + "nullable": true }, "size": { "type": "integer", "description": "Maximum size of the varchar attribute.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -19389,7 +19403,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19399,7 +19413,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19464,7 +19478,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19474,7 +19488,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19551,7 +19565,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19561,7 +19575,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19584,7 +19598,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -19594,7 +19608,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -19606,7 +19620,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -19742,7 +19756,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19752,7 +19766,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -19766,7 +19780,7 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -19775,22 +19789,29 @@ "type": "object", "description": "Document data as JSON object.", "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "documents": { "type": "array", "description": "Array of documents data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -19798,8 +19819,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } }, "required": [ @@ -19902,7 +19923,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -19912,7 +19933,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -19926,7 +19947,6 @@ "documents": { "type": "array", "description": "Array of document data as JSON objects. May contain partial documents.", - "x-example": null, "items": { "type": "object" } @@ -19934,8 +19954,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } }, "required": [ @@ -20003,7 +20023,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20013,7 +20033,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -20028,13 +20048,18 @@ "type": "object", "description": "Document data as JSON object. Include only attribute 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}" + "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" } @@ -20042,8 +20067,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -20108,7 +20133,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20118,7 +20143,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20141,7 +20166,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -20209,7 +20234,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20219,7 +20244,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20229,7 +20254,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20252,7 +20277,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -20354,7 +20379,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20364,7 +20389,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20377,7 +20402,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "" + "example": "" }, "in": "path" } @@ -20392,22 +20417,30 @@ "type": "object", "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -20475,7 +20508,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20485,7 +20518,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20495,7 +20528,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -20510,22 +20543,30 @@ "type": "object", "description": "Document data as JSON object. Include only attribute 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}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -20586,7 +20627,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20596,7 +20637,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20606,7 +20647,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20616,7 +20657,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -20684,7 +20725,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20694,7 +20735,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20704,7 +20745,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20728,21 +20769,19 @@ "type": "number", "description": "Value to increment the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "min": { "type": "number", "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -20812,7 +20851,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20822,7 +20861,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20832,7 +20871,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20856,21 +20895,19 @@ "type": "number", "description": "Value to increment the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "max": { "type": "number", "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -20937,7 +20974,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20947,7 +20984,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -20970,7 +21007,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -21034,7 +21071,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -21044,7 +21081,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -21057,13 +21094,12 @@ "properties": { "key": { "type": "string", - "description": "Index Key.", - "x-example": null + "description": "Index Key." }, "type": { "type": "string", "description": "Index type.", - "x-example": "key", + "example": "key", "enum": [ "key", "fulltext", @@ -21081,7 +21117,6 @@ "attributes": { "type": "array", "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "x-example": null, "items": { "type": "string" } @@ -21090,7 +21125,6 @@ "type": "array", "description": "Array of index orders. Maximum of 100 orders are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -21108,7 +21142,6 @@ "type": "array", "description": "Length of index. Maximum of 100", "default": [], - "x-example": null, "items": { "type": "integer" } @@ -21183,7 +21216,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -21193,7 +21226,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -21258,7 +21291,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -21268,7 +21301,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -21351,7 +21384,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -21413,7 +21446,7 @@ "databaseId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -21421,32 +21454,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "enabled": { "type": "boolean", "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.", "default": "serverless", - "x-example": "serverless" + "example": "serverless" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } }, "required": [ @@ -21632,7 +21665,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -21699,7 +21732,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -21761,7 +21794,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -21776,13 +21809,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -21839,7 +21872,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -21900,7 +21933,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -21959,7 +21992,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -21973,32 +22006,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "enabled": { "type": "boolean", "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.", - "x-example": "serverless", - "x-nullable": true + "example": "serverless", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } }, "required": [ @@ -22055,7 +22088,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -22116,7 +22149,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -22139,7 +22172,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -22150,7 +22183,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -22210,7 +22243,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -22224,7 +22257,7 @@ "collectionId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -22232,34 +22265,35 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "documentSecurity": { "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "attributes": { "type": "array", "description": "Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, varchar, text, mediumtext, longtext, integer, bigint, double, boolean, datetime, point, linestring, polygon, email, url, ip, enum), size (integer, required for string and varchar types), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -22268,7 +22302,6 @@ "type": "array", "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", "default": [], - "x-example": null, "items": { "type": "object" } @@ -22338,7 +22371,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -22348,7 +22381,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -22407,7 +22440,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -22417,7 +22450,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -22431,12 +22464,14 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "" + "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -22445,19 +22480,19 @@ "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "purge": { "type": "boolean", "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -22514,7 +22549,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -22524,7 +22559,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -22588,7 +22623,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -22598,7 +22633,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -22621,7 +22656,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -22631,7 +22666,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -22643,7 +22678,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -22765,7 +22800,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -22775,7 +22810,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -22789,7 +22824,7 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -22798,12 +22833,20 @@ "type": "object", "description": "Document data as JSON object.", "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -22812,7 +22855,6 @@ "type": "array", "description": "Array of documents data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -22820,7 +22862,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } }, "required": [ @@ -22915,7 +22957,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -22925,7 +22967,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -22939,7 +22981,6 @@ "documents": { "type": "array", "description": "Array of document data as JSON objects. May contain partial documents.", - "x-example": null, "items": { "type": "object" } @@ -22947,7 +22988,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } }, "required": [ @@ -23011,7 +23052,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23021,7 +23062,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -23036,13 +23077,12 @@ "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", "default": [], - "x-example": "{}" + "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" } @@ -23050,7 +23090,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -23111,7 +23151,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23121,7 +23161,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23144,7 +23184,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -23208,7 +23248,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23218,7 +23258,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23228,7 +23268,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23251,7 +23291,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -23345,7 +23385,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23355,7 +23395,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23365,7 +23405,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -23380,12 +23420,14 @@ "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -23393,7 +23435,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -23457,7 +23499,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23467,7 +23509,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23477,7 +23519,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -23492,12 +23534,14 @@ "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -23505,7 +23549,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -23562,7 +23606,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23572,7 +23616,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23582,7 +23626,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23592,7 +23636,7 @@ "required": false, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" } @@ -23656,7 +23700,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23666,7 +23710,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23676,7 +23720,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23700,19 +23744,17 @@ "type": "number", "description": "Value to decrement the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "min": { "type": "number", "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, "format": "float" }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -23778,7 +23820,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23788,7 +23830,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23798,7 +23840,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23822,19 +23864,17 @@ "type": "number", "description": "Value to increment the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "max": { "type": "number", "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, "format": "float" }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "" + "example": "" } } } @@ -23897,7 +23937,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23907,7 +23947,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -23930,7 +23970,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -23990,7 +24030,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -24000,7 +24040,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -24013,13 +24053,12 @@ "properties": { "key": { "type": "string", - "description": "Index Key.", - "x-example": null + "description": "Index Key." }, "type": { "type": "string", "description": "Index type.", - "x-example": "key", + "example": "key", "enum": [ "key", "fulltext", @@ -24035,7 +24074,6 @@ "attributes": { "type": "array", "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "x-example": null, "items": { "type": "string" } @@ -24044,7 +24082,6 @@ "type": "array", "description": "Array of index orders. Maximum of 100 orders are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -24062,7 +24099,6 @@ "type": "array", "description": "Length of index. Maximum of 100", "default": [], - "x-example": null, "items": { "type": "integer" } @@ -24133,7 +24169,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -24143,7 +24179,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -24204,7 +24240,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -24214,7 +24250,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -24283,7 +24319,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -24297,8 +24333,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -24360,7 +24396,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -24370,7 +24406,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -24381,7 +24417,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -24393,7 +24429,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -24454,7 +24490,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -24514,7 +24550,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -24585,7 +24621,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -24644,12 +24680,11 @@ "teamId": { "type": "string", "description": "Team unique ID.", - "x-example": "" + "example": "" }, "domain": { "type": "string", - "description": "Domain name (e.g. \"example.com\").", - "x-example": null + "description": "Domain name (e.g. \"example.com\")." } }, "required": [ @@ -24733,7 +24768,7 @@ "required": false, "schema": { "type": "string", - "x-example": "new", + "example": "new", "enum": [ "new", "transfer", @@ -24806,70 +24841,69 @@ "properties": { "domain": { "type": "string", - "description": "Fully qualified domain name to purchase (for example, example.com).", - "x-example": null + "description": "Fully qualified domain name to purchase (for example, example.com)." }, "organizationId": { "type": "string", "description": "Team ID that will own the domain.", - "x-example": "" + "example": "" }, "firstName": { "type": "string", "description": "Registrant first name used for domain registration.", - "x-example": "" + "example": "" }, "lastName": { "type": "string", "description": "Registrant last name used for domain registration.", - "x-example": "" + "example": "" }, "email": { "type": "string", "description": "Registrant email address for registration and notices.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "phone": { "type": "string", "description": "Registrant phone number in E.164 format (for example, +15555551234).", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "billingAddressId": { "type": "string", "description": "Billing address ID used for registration contact details.", - "x-example": "" + "example": "" }, "addressLine3": { "type": "string", "description": "Additional address line for the registrant (line 3).", "default": "", - "x-example": "" + "example": "" }, "companyName": { "type": "string", "description": "Company or organization name for the registrant.", "default": "", - "x-example": "" + "example": "" }, "periodYears": { "type": "integer", "description": "Registration term in years (1-10).", "default": 1, - "x-example": 1, + "example": 1, "format": "int32" }, "autoRenewal": { "type": "boolean", "description": "Whether the domain should renew automatically after purchase.", "default": true, - "x-example": false + "example": false }, "paymentMethodId": { "type": "string", "description": "Payment method ID to authorize and capture the purchase.", - "x-example": "" + "example": "" } }, "required": [ @@ -24939,7 +24973,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -24953,7 +24987,7 @@ "organizationId": { "type": "string", "description": "Team ID that owns the domain.", - "x-example": "" + "example": "" } }, "required": [ @@ -25016,7 +25050,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -25049,7 +25083,7 @@ "required": false, "schema": { "type": "string", - "x-example": "premium", + "example": "premium", "enum": [ "premium", "suggestion" @@ -25137,29 +25171,28 @@ "properties": { "domain": { "type": "string", - "description": "Domain name to transfer in.", - "x-example": null + "description": "Domain name to transfer in." }, "organizationId": { "type": "string", "description": "Organization ID that this domain will belong to.", - "x-example": "" + "example": "" }, "authCode": { "type": "string", "description": "Authorization code for the domain transfer.", - "x-example": "" + "example": "" }, "autoRenewal": { "type": "boolean", "description": "Whether the domain should renew automatically after transfer.", "default": true, - "x-example": false + "example": false }, "paymentMethodId": { "type": "string", "description": "Payment method ID to authorize and capture the transfer.", - "x-example": "" + "example": "" } }, "required": [ @@ -25225,7 +25258,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25239,7 +25272,7 @@ "organizationId": { "type": "string", "description": "Team ID that owns the domain.", - "x-example": "" + "example": "" } }, "required": [ @@ -25304,12 +25337,12 @@ "domainId": { "type": "string", "description": "Domain unique ID.", - "x-example": "" + "example": "" }, "organizationId": { "type": "string", "description": "Organization ID that this domain belongs to.", - "x-example": "" + "example": "" } }, "required": [ @@ -25373,7 +25406,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25425,7 +25458,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25483,7 +25516,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25497,7 +25530,7 @@ "autoRenewal": { "type": "boolean", "description": "Whether the domain should renew automatically.", - "x-example": false + "example": false } }, "required": [ @@ -25560,7 +25593,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25575,7 +25608,6 @@ "type": "array", "description": "Nameservers to set for the domain. Defaults to Appwrite nameservers when omitted.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -25638,7 +25670,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25696,7 +25728,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25752,7 +25784,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25810,7 +25842,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25866,7 +25898,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25924,7 +25956,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -25980,7 +26012,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26038,7 +26070,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26094,7 +26126,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26152,7 +26184,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26208,7 +26240,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26266,7 +26298,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26322,7 +26354,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26393,7 +26425,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26451,7 +26483,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26464,25 +26496,23 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", - "description": "IPv4 address for this A record.", - "x-example": null + "description": "IPv4 address for this A record." }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment explaining what this record is for.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -26547,7 +26577,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -26557,7 +26587,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26570,25 +26600,23 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", - "description": "IPv4 address for this A record.", - "x-example": null + "description": "IPv4 address for this A record." }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment explaining what this record is for.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -26653,7 +26681,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26666,25 +26694,23 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", - "description": "IPv6 address for this AAAA record.", - "x-example": null + "description": "IPv6 address for this AAAA record." }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment explaining what this record is for.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -26749,7 +26775,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -26759,7 +26785,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26772,25 +26798,23 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", - "description": "IPv6 address for this AAAA record.", - "x-example": null + "description": "IPv6 address for this AAAA record." }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -26855,7 +26879,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26868,25 +26892,24 @@ "properties": { "name": { "type": "string", - "description": "Record name.", - "x-example": null + "description": "Record name." }, "value": { "type": "string", "description": "Target domain for this ALIAS record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -26951,7 +26974,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -26961,7 +26984,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -26974,25 +26997,24 @@ "properties": { "name": { "type": "string", - "description": "Record name.", - "x-example": null + "description": "Record name." }, "value": { "type": "string", "description": "Target domain for this ALIAS record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -27057,7 +27079,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -27070,25 +27092,23 @@ "properties": { "name": { "type": "string", - "description": "Record name.", - "x-example": null + "description": "Record name." }, "value": { "type": "string", - "description": "CAA value (e.g. issuer domain).", - "x-example": null + "description": "CAA value (e.g. issuer domain)." }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -27153,7 +27173,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -27163,7 +27183,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -27176,25 +27196,23 @@ "properties": { "name": { "type": "string", - "description": "Record name.", - "x-example": null + "description": "Record name." }, "value": { "type": "string", - "description": "CAA value (e.g. issuer domain).", - "x-example": null + "description": "CAA value (e.g. issuer domain)." }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -27259,7 +27277,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -27272,25 +27290,24 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", "description": "Canonical target for this CNAME record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -27355,7 +27372,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -27365,7 +27382,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -27378,25 +27395,24 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", "description": "Canonical target for this CNAME record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -27461,7 +27477,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -27474,25 +27490,24 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", "description": "Target for the HTTPS record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -27557,7 +27572,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -27567,7 +27582,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -27580,25 +27595,24 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", "description": "Target for the HTTPS record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -27663,7 +27677,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -27676,31 +27690,29 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", "description": "Mail server domain for this MX record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "priority": { "type": "integer", "description": "MX priority.", - "x-example": null, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -27766,7 +27778,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -27776,7 +27788,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -27789,31 +27801,29 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", "description": "Mail server domain for this MX record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "priority": { "type": "integer", "description": "MX priority.", - "x-example": null, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -27879,7 +27889,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -27892,25 +27902,24 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", "description": "Nameserver target for this NS record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -27975,7 +27984,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -27985,7 +27994,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -27998,25 +28007,24 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", - "x-example": null + "description": "Record name (subdomain)." }, "value": { "type": "string", "description": "Nameserver target for this NS record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -28081,7 +28089,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -28094,43 +28102,39 @@ "properties": { "name": { "type": "string", - "description": "Record name (service name).", - "x-example": null + "description": "Record name (service name)." }, "value": { "type": "string", "description": "Target hostname for this SRV record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "priority": { "type": "integer", "description": "Record priority.", - "x-example": null, "format": "int32" }, "weight": { "type": "integer", "description": "Record weight.", - "x-example": null, "format": "int32" }, "port": { "type": "integer", "description": "Port number for the service.", - "x-example": null, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -28198,7 +28202,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -28208,7 +28212,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -28221,43 +28225,39 @@ "properties": { "name": { "type": "string", - "description": "Record name (service name).", - "x-example": null + "description": "Record name (service name)." }, "value": { "type": "string", "description": "Target hostname for this SRV record.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "priority": { "type": "integer", "description": "Record priority.", - "x-example": null, "format": "int32" }, "weight": { "type": "integer", "description": "Record weight.", - "x-example": null, "format": "int32" }, "port": { "type": "integer", "description": "Port number for the service.", - "x-example": null, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -28325,7 +28325,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -28338,26 +28338,25 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain) for the TXT record.", - "x-example": null + "description": "Record name (subdomain) for the TXT record." }, "value": { "type": "string", "description": "TXT record value.", "default": "", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -28421,7 +28420,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -28431,7 +28430,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -28444,25 +28443,24 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain) for the TXT record.", - "x-example": null + "description": "Record name (subdomain) for the TXT record." }, "value": { "type": "string", "description": "TXT record value.", - "x-example": "" + "example": "" }, "ttl": { "type": "integer", "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "example": 1, "format": "int32" }, "comment": { "type": "string", "description": "A comment for this record.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -28527,7 +28525,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -28537,7 +28535,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -28589,7 +28587,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -28599,7 +28597,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -28657,7 +28655,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -28671,7 +28669,7 @@ "teamId": { "type": "string", "description": "New team unique ID.", - "x-example": "" + "example": "" } }, "required": [ @@ -28734,7 +28732,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -28792,7 +28790,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -28848,7 +28846,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -28862,7 +28860,7 @@ "content": { "type": "string", "description": "DNS zone file content as a string.", - "x-example": "" + "example": "" } }, "required": [ @@ -28957,7 +28955,6 @@ "texts": { "type": "array", "description": "Array of text to generate embeddings.", - "x-example": null, "items": { "type": "string" } @@ -28966,7 +28963,7 @@ "type": "string", "description": "The embedding model to use for generating vector embeddings.", "default": "nomic-embed-text", - "x-example": "nomic-embed-text", + "example": "nomic-embed-text", "enum": [ "nomic-embed-text", "embedding-gemma", @@ -29057,7 +29054,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -29068,7 +29065,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -29129,7 +29126,7 @@ "functionId": { "type": "string", "description": "Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -29137,12 +29134,12 @@ "name": { "type": "string", "description": "Function name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "runtime": { "type": "string", "description": "Execution runtime.", - "x-example": "node-14.5", + "example": "node-14.5", "enum": [ "node-14.5", "node-16.0", @@ -29176,9 +29173,6 @@ "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", @@ -29274,9 +29268,6 @@ "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", @@ -29343,7 +29334,9 @@ "type": "array", "description": "An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.", "default": [], - "x-example": "[\"any\"]", + "example": [ + "any" + ], "items": { "type": "string" } @@ -29352,7 +29345,6 @@ "type": "array", "description": "Events list. Maximum of 100 events are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -29360,45 +29352,43 @@ "schedule": { "type": "string", "description": "Schedule CRON syntax.", - "default": "", - "x-example": null + "default": "" }, "timeout": { "type": "integer", "description": "Function maximum execution time in seconds.", "default": 15, - "x-example": 1, + "example": 1, "format": "int32" }, "enabled": { "type": "boolean", "description": "Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", "default": true, - "x-example": false + "example": false }, "entrypoint": { "type": "string", "description": "Entrypoint File. This path is relative to the \"providerRootDirectory\".", "default": "", - "x-example": "" + "example": "" }, "commands": { "type": "string", "description": "Build Commands.", "default": "", - "x-example": "" + "example": "" }, "scopes": { "type": "array", "description": "List of scopes allowed for API key auto-generated for every execution. Maximum of 200 scopes are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -29622,37 +29612,36 @@ "type": "string", "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", "default": "", - "x-example": "" + "example": "" }, "providerRepositoryId": { "type": "string", "description": "Repository ID of the repo linked to the function.", "default": "", - "x-example": "" + "example": "" }, "providerBranch": { "type": "string", "description": "Production branch for the repo linked to the function.", "default": "", - "x-example": "" + "example": "" }, "providerSilentMode": { "type": "boolean", "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.", "default": false, - "x-example": false + "example": false }, "providerRootDirectory": { "type": "string", "description": "Path to function code in the linked repo.", "default": "", - "x-example": "" + "example": "" }, "providerBranches": { "type": "array", "description": "List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -29661,7 +29650,6 @@ "type": "array", "description": "List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -29669,20 +29657,18 @@ "buildSpecification": { "type": "string", "description": "Build specification for the function deployments.", - "default": {}, - "x-example": null + "default": {} }, "runtimeSpecification": { "type": "string", "description": "Runtime specification for the function executions.", - "default": {}, - "x-example": null + "default": {} }, "deploymentRetention": { "type": "integer", "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -29798,7 +29784,7 @@ "required": false, "schema": { "type": "string", - "x-example": "runtimes", + "example": "runtimes", "default": "runtimes" }, "in": "query" @@ -29892,9 +29878,6 @@ "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", @@ -29990,9 +29973,6 @@ "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", @@ -30098,7 +30078,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -30110,7 +30090,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -30121,7 +30101,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -30180,7 +30160,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -30240,7 +30220,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -30298,7 +30278,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -30312,12 +30292,12 @@ "name": { "type": "string", "description": "Function name. Max length: 128 chars.", - "x-example": "" + "example": "" }, "runtime": { "type": "string", "description": "Execution runtime.", - "x-example": "node-14.5", + "example": "node-14.5", "enum": [ "node-14.5", "node-16.0", @@ -30351,9 +30331,6 @@ "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", @@ -30449,9 +30426,6 @@ "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", @@ -30518,7 +30492,9 @@ "type": "array", "description": "An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.", "default": [], - "x-example": "[\"any\"]", + "example": [ + "any" + ], "items": { "type": "string" } @@ -30527,7 +30503,6 @@ "type": "array", "description": "Events list. Maximum of 100 events are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -30535,45 +30510,43 @@ "schedule": { "type": "string", "description": "Schedule CRON syntax.", - "default": "", - "x-example": null + "default": "" }, "timeout": { "type": "integer", "description": "Maximum execution time in seconds.", "default": 15, - "x-example": 1, + "example": 1, "format": "int32" }, "enabled": { "type": "boolean", "description": "Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", "default": true, - "x-example": false + "example": false }, "entrypoint": { "type": "string", "description": "Entrypoint File. This path is relative to the \"providerRootDirectory\".", "default": "", - "x-example": "" + "example": "" }, "commands": { "type": "string", "description": "Build Commands.", "default": "", - "x-example": "" + "example": "" }, "scopes": { "type": "array", "description": "List of scopes allowed for API Key auto-generated for every execution. Maximum of 200 scopes are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -30797,67 +30770,63 @@ "type": "string", "description": "Appwrite Installation ID for VCS (Version Controle System) deployment.", "default": "", - "x-example": "" + "example": "" }, "providerRepositoryId": { "type": "string", "description": "Repository ID of the repo linked to the function", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "providerBranch": { "type": "string", "description": "Production branch for the repo linked to the function", "default": "", - "x-example": "" + "example": "" }, "providerSilentMode": { "type": "boolean", "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.", "default": false, - "x-example": false + "example": false }, "providerRootDirectory": { "type": "string", "description": "Path to function code in the linked repo.", "default": "", - "x-example": "" + "example": "" }, "providerBranches": { "type": "array", "description": "List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "providerPaths": { "type": "array", "description": "List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "buildSpecification": { "type": "string", "description": "Build specification for the function deployments.", - "x-example": null, - "x-nullable": true + "nullable": true }, "runtimeSpecification": { "type": "string", "description": "Runtime specification for the function executions.", - "x-example": null, - "x-nullable": true + "nullable": true }, "deploymentRetention": { "type": "integer", "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -30914,7 +30883,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -30974,7 +30943,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -30988,7 +30957,7 @@ "deploymentId": { "type": "string", "description": "Deployment ID.", - "x-example": "" + "example": "" } }, "required": [ @@ -31053,7 +31022,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -31076,7 +31045,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -31087,7 +31056,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -31146,7 +31115,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -31160,25 +31129,24 @@ "entrypoint": { "type": "string", "description": "Entrypoint File.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "commands": { "type": "string", "description": "Build Commands.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "code": { "type": "string", "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", - "x-example": null, "format": "binary" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", - "x-example": false + "example": false } }, "required": [ @@ -31244,7 +31212,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -31258,13 +31226,13 @@ "deploymentId": { "type": "string", "description": "Deployment ID.", - "x-example": "" + "example": "" }, "buildId": { "type": "string", "description": "Build unique ID.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -31329,7 +31297,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -31343,22 +31311,22 @@ "repository": { "type": "string", "description": "Repository name of the template.", - "x-example": "" + "example": "" }, "owner": { "type": "string", "description": "The name of the owner of the template.", - "x-example": "" + "example": "" }, "rootDirectory": { "type": "string", "description": "Path to function code in the template repo.", - "x-example": "" + "example": "" }, "type": { "type": "string", "description": "Type for the reference provided. Can be commit, branch, or tag", - "x-example": "commit", + "example": "commit", "enum": [ "commit", "branch", @@ -31374,13 +31342,13 @@ "reference": { "type": "string", "description": "Reference value, can be a commit hash, branch name, or release tag", - "x-example": "" + "example": "" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -31449,7 +31417,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -31463,7 +31431,7 @@ "type": { "type": "string", "description": "Type of reference passed. Allowed values are: branch, commit", - "x-example": "branch", + "example": "branch", "enum": [ "branch", "commit" @@ -31477,13 +31445,13 @@ "reference": { "type": "string", "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", - "x-example": "" + "example": "" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -31549,7 +31517,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -31559,7 +31527,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -31610,7 +31578,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -31620,7 +31588,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -31687,7 +31655,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -31697,7 +31665,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -31707,7 +31675,7 @@ "required": false, "schema": { "type": "string", - "x-example": "source", + "example": "source", "enum": [ "source", "output" @@ -31727,7 +31695,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -31788,7 +31756,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -31798,7 +31766,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -31864,7 +31832,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -31887,7 +31855,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -31952,7 +31920,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -31967,25 +31935,25 @@ "type": "string", "description": "HTTP body of execution. Default value is empty string.", "default": "", - "x-example": "" + "example": "" }, "async": { "type": "boolean", "description": "Execute code in the background. Default value is false.", "default": false, - "x-example": false + "example": false }, "path": { "type": "string", "description": "HTTP path of execution. Path can include query params. Default value is \/", "default": "\/", - "x-example": "" + "example": "" }, "method": { "type": "string", "description": "HTTP method of execution. Default value is POST.", "default": "POST", - "x-example": "GET", + "example": "GET", "enum": [ "GET", "POST", @@ -32010,13 +31978,13 @@ "type": "object", "description": "HTTP headers of execution. Defaults to empty.", "default": [], - "x-example": "{}" + "example": {} }, "scheduledAt": { "type": "string", "description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true } } } @@ -32084,7 +32052,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -32094,7 +32062,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -32148,7 +32116,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -32158,7 +32126,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -32218,7 +32186,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -32241,7 +32209,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -32300,7 +32268,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -32314,7 +32282,7 @@ "variableId": { "type": "string", "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -32322,18 +32290,18 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "" + "example": "" }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "" + "example": "" }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -32400,7 +32368,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -32410,7 +32378,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -32468,7 +32436,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -32478,7 +32446,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -32492,20 +32460,20 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -32558,7 +32526,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" }, @@ -32568,7 +32536,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -32635,7 +32603,7 @@ "type": "object", "description": "The query or queries to execute.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -32707,7 +32675,7 @@ "type": "object", "description": "The query or queries to execute.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -33180,12 +33148,12 @@ "projectId": { "type": "string", "description": "Project ID", - "x-example": "" + "example": "" }, "resourceType": { "type": "string", "description": "Resource type to block (e.g., projects, functions, databases, storage, etc.)", - "x-example": "projects", + "example": "projects", "enum": [ "projects", "functions", @@ -33214,13 +33182,13 @@ "type": "string", "description": "Optional resource ID (if omitted, all resources of this type will be blocked)", "default": "", - "x-example": "" + "example": "" }, "mode": { "type": "string", "description": "Block mode. Use full to block reads and writes, or readOnly to block database writes only.", "default": "full", - "x-example": "full", + "example": "full", "enum": [ "full", "readonly" @@ -33235,13 +33203,13 @@ "type": "string", "description": "Optional reason why the resource is blocked", "default": "", - "x-example": "" + "example": "" }, "expiredAt": { "type": "string", "description": "Optional expiration date for the block", "default": "", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime" } }, @@ -33296,7 +33264,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "query" }, @@ -33306,7 +33274,7 @@ "required": true, "schema": { "type": "string", - "x-example": "projects", + "example": "projects", "enum": [ "projects", "functions", @@ -33339,7 +33307,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -33390,7 +33358,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -33441,7 +33409,7 @@ "required": false, "schema": { "type": "string", - "x-example": "fra", + "example": "fra", "enum": [ "fra", "nyc", @@ -33468,7 +33436,7 @@ "required": false, "schema": { "type": "string", - "x-example": "cache", + "example": "cache", "enum": [ "cache", "timelimit", @@ -33496,7 +33464,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": false }, "in": "query" @@ -33507,7 +33475,7 @@ "required": false, "schema": { "type": "string", - "x-example": "console", + "example": "console", "enum": [ "console", "project", @@ -33529,7 +33497,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -33540,7 +33508,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -33551,7 +33519,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -33605,24 +33573,24 @@ "type": "string", "description": "User ID.", "default": "", - "x-example": "" + "example": "" }, "email": { "type": "string", "description": "User email address.", "default": "", - "x-example": "" + "example": "" }, "status": { "type": "boolean", "description": "User status. Set to `false` to block and `true` to unblock.", - "x-example": false + "example": false }, "reason": { "type": "string", "description": "Optional reason when blocking a user. Accepted for parity with the CLI task but not persisted.", "default": "", - "x-example": "" + "example": "" } }, "required": [ @@ -33701,7 +33669,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -33712,7 +33680,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -33776,7 +33744,7 @@ "messageId": { "type": "string", "description": "Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -33784,18 +33752,17 @@ "subject": { "type": "string", "description": "Email Subject.", - "x-example": "" + "example": "" }, "content": { "type": "string", "description": "Email Content.", - "x-example": "" + "example": "" }, "topics": { "type": "array", "description": "List of Topic IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -33804,7 +33771,6 @@ "type": "array", "description": "List of User IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -33813,7 +33779,6 @@ "type": "array", "description": "List of Targets IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -33822,7 +33787,6 @@ "type": "array", "description": "Array of target IDs to be added as CC.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -33831,7 +33795,6 @@ "type": "array", "description": "Array of target IDs to be added as BCC.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -33840,7 +33803,6 @@ "type": "array", "description": "Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as :.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -33849,20 +33811,20 @@ "type": "boolean", "description": "Is message a draft", "default": false, - "x-example": false + "example": false }, "html": { "type": "boolean", "description": "Is content of type HTML", "default": false, - "x-example": false + "example": false }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -33930,7 +33892,7 @@ "required": true, "schema": { "type": "string", - "x-example": "" + "example": "" }, "in": "path" } @@ -33944,87 +33906,81 @@ "topics": { "type": "array", "description": "List of Topic IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "users": { "type": "array", "description": "List of User IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "targets": { "type": "array", "description": "List of Targets IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "subject": { "type": "string", "description": "Email Subject.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "content": { "type": "string", "description": "Email Content.", - "x-example": "", - "x-nullable": true + "example": "", + "nullable": true }, "draft": { "type": "boolean", "description": "Is message a draft", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "html": { "type": "boolean", "description": "Is content of type HTML", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "cc": { "type": "array", "description": "Array of target IDs to be added as CC.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "bcc": { "type": "array", "description": "Array of target IDs to be added as BCC.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "attachments": { "type": "array", "description": "Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as :.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true } } } @@ -34089,7 +34045,7 @@ "messageId": { "type": "string", "description": "Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "", + "example": "", "x-appwrite": { "idGenerator": "ID.unique" } @@ -34098,19 +34054,18 @@ "type": "string", "description": "Title for push notification.", "default": "", - "x-example": "" + "example": "<TITLE>" }, "body": { "type": "string", "description": "Body for push notification.", "default": "", - "x-example": "<BODY>" + "example": "<BODY>" }, "topics": { "type": "array", "description": "List of Topic IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -34119,7 +34074,6 @@ "type": "array", "description": "List of User IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -34128,7 +34082,6 @@ "type": "array", "description": "List of Targets IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -34137,82 +34090,81 @@ "type": "object", "description": "Additional key-value pair data for push notification.", "default": {}, - "x-example": "{}", - "x-nullable": true + "example": {}, + "nullable": true }, "action": { "type": "string", "description": "Action for push notification.", "default": "", - "x-example": "<ACTION>" + "example": "<ACTION>" }, "image": { "type": "string", "description": "Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.", "default": "", - "x-example": "<ID1:ID2>" + "example": "<ID1:ID2>" }, "icon": { "type": "string", "description": "Icon for push notification. Available only for Android and Web Platform.", "default": "", - "x-example": "<ICON>" + "example": "<ICON>" }, "sound": { "type": "string", "description": "Sound for push notification. Available only for Android and iOS Platform.", "default": "", - "x-example": "<SOUND>" + "example": "<SOUND>" }, "color": { "type": "string", "description": "Color for push notification. Available only for Android Platform.", "default": "", - "x-example": "<COLOR>" + "example": "<COLOR>" }, "tag": { "type": "string", "description": "Tag for push notification. Available only for Android Platform.", "default": "", - "x-example": "<TAG>" + "example": "<TAG>" }, "badge": { "type": "integer", "description": "Badge for push notification. Available only for iOS Platform.", "default": -1, - "x-example": null, "format": "int32" }, "draft": { "type": "boolean", "description": "Is message a draft", "default": false, - "x-example": false + "example": false }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "contentAvailable": { "type": "boolean", "description": "If set to true, the notification will be delivered in the background. Available only for iOS Platform.", "default": false, - "x-example": false + "example": false }, "critical": { "type": "boolean", "description": "If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.", "default": false, - "x-example": false + "example": false }, "priority": { "type": "string", "description": "Set the notification priority. \"normal\" will consider device state and may not deliver notifications immediately. \"high\" will always attempt to immediately deliver the notification.", "default": "high", - "x-example": "normal", + "example": "normal", "enum": [ "normal", "high" @@ -34287,7 +34239,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" } @@ -34301,121 +34253,117 @@ "topics": { "type": "array", "description": "List of Topic IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "users": { "type": "array", "description": "List of User IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "targets": { "type": "array", "description": "List of Targets IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "title": { "type": "string", "description": "Title for push notification.", - "x-example": "<TITLE>", - "x-nullable": true + "example": "<TITLE>", + "nullable": true }, "body": { "type": "string", "description": "Body for push notification.", - "x-example": "<BODY>", - "x-nullable": true + "example": "<BODY>", + "nullable": true }, "data": { "type": "object", "description": "Additional Data for push notification.", "default": {}, - "x-example": "{}", - "x-nullable": true + "example": {}, + "nullable": true }, "action": { "type": "string", "description": "Action for push notification.", - "x-example": "<ACTION>", - "x-nullable": true + "example": "<ACTION>", + "nullable": true }, "image": { "type": "string", "description": "Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.", - "x-example": "<ID1:ID2>", - "x-nullable": true + "example": "<ID1:ID2>", + "nullable": true }, "icon": { "type": "string", "description": "Icon for push notification. Available only for Android and Web platforms.", - "x-example": "<ICON>", - "x-nullable": true + "example": "<ICON>", + "nullable": true }, "sound": { "type": "string", "description": "Sound for push notification. Available only for Android and iOS platforms.", - "x-example": "<SOUND>", - "x-nullable": true + "example": "<SOUND>", + "nullable": true }, "color": { "type": "string", "description": "Color for push notification. Available only for Android platforms.", - "x-example": "<COLOR>", - "x-nullable": true + "example": "<COLOR>", + "nullable": true }, "tag": { "type": "string", "description": "Tag for push notification. Available only for Android platforms.", - "x-example": "<TAG>", - "x-nullable": true + "example": "<TAG>", + "nullable": true }, "badge": { "type": "integer", "description": "Badge for push notification. Available only for iOS platforms.", - "x-example": null, "format": "int32", - "x-nullable": true + "nullable": true }, "draft": { "type": "boolean", "description": "Is message a draft", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "contentAvailable": { "type": "boolean", "description": "If set to true, the notification will be delivered in the background. Available only for iOS Platform.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "critical": { "type": "boolean", "description": "If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "priority": { "type": "string", "description": "Set the notification priority. \"normal\" will consider device battery state and may send notifications later. \"high\" will always attempt to immediately deliver the notification.", - "x-example": "normal", + "example": "normal", "enum": [ "normal", "high" @@ -34425,7 +34373,7 @@ "normal", "high" ], - "x-nullable": true + "nullable": true } } } @@ -34560,7 +34508,7 @@ "messageId": { "type": "string", "description": "Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<MESSAGE_ID>", + "example": "<MESSAGE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -34568,13 +34516,12 @@ "content": { "type": "string", "description": "SMS Content.", - "x-example": "<CONTENT>" + "example": "<CONTENT>" }, "topics": { "type": "array", "description": "List of Topic IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -34583,7 +34530,6 @@ "type": "array", "description": "List of User IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -34592,7 +34538,6 @@ "type": "array", "description": "List of Targets IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -34601,14 +34546,14 @@ "type": "boolean", "description": "Is message a draft", "default": false, - "x-example": false + "example": false }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -34743,7 +34688,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" } @@ -34757,48 +34702,45 @@ "topics": { "type": "array", "description": "List of Topic IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "users": { "type": "array", "description": "List of User IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "targets": { "type": "array", "description": "List of Targets IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "content": { "type": "string", "description": "Email Content.", - "x-example": "<CONTENT>", - "x-nullable": true + "example": "<CONTENT>", + "nullable": true }, "draft": { "type": "boolean", "description": "Is message a draft", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -34861,7 +34803,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" } @@ -34913,7 +34855,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" } @@ -34974,7 +34916,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" }, @@ -34997,7 +34939,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -35072,7 +35014,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -35083,7 +35025,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -35219,7 +35161,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -35227,43 +35169,43 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "authKey": { "type": "string", "description": "APNS authentication key.", "default": "", - "x-example": "<AUTH_KEY>" + "example": "<AUTH_KEY>" }, "authKeyId": { "type": "string", "description": "APNS authentication key ID.", "default": "", - "x-example": "<AUTH_KEY_ID>" + "example": "<AUTH_KEY_ID>" }, "teamId": { "type": "string", "description": "APNS team ID.", "default": "", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "bundleId": { "type": "string", "description": "APNS bundle ID.", "default": "", - "x-example": "<BUNDLE_ID>" + "example": "<BUNDLE_ID>" }, "sandbox": { "type": "boolean", "description": "Use APNS sandbox environment.", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -35400,7 +35342,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -35415,43 +35357,43 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "authKey": { "type": "string", "description": "APNS authentication key.", "default": "", - "x-example": "<AUTH_KEY>" + "example": "<AUTH_KEY>" }, "authKeyId": { "type": "string", "description": "APNS authentication key ID.", "default": "", - "x-example": "<AUTH_KEY_ID>" + "example": "<AUTH_KEY_ID>" }, "teamId": { "type": "string", "description": "APNS team ID.", "default": "", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "bundleId": { "type": "string", "description": "APNS bundle ID.", "default": "", - "x-example": "<BUNDLE_ID>" + "example": "<BUNDLE_ID>" }, "sandbox": { "type": "boolean", "description": "Use APNS sandbox environment.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -35580,7 +35522,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -35588,20 +35530,20 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "serviceAccountJSON": { "type": "object", "description": "FCM service account JSON.", "default": {}, - "x-example": "{}", - "x-nullable": true + "example": {}, + "nullable": true }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -35730,7 +35672,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -35745,20 +35687,20 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "serviceAccountJSON": { "type": "object", "description": "FCM service account JSON.", "default": {}, - "x-example": "{}", - "x-nullable": true + "example": {}, + "nullable": true } } } @@ -35823,7 +35765,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -35831,57 +35773,57 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "apiKey": { "type": "string", "description": "Mailgun API Key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "domain": { "type": "string", "description": "Mailgun Domain.", "default": "", - "x-example": "<DOMAIN>" + "example": "<DOMAIN>" }, "isEuRegion": { "type": "boolean", "description": "Set as EU region.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -35948,7 +35890,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -35963,56 +35905,56 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "apiKey": { "type": "string", "description": "Mailgun API Key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "domain": { "type": "string", "description": "Mailgun Domain.", "default": "", - "x-example": "<DOMAIN>" + "example": "<DOMAIN>" }, "isEuRegion": { "type": "boolean", "description": "Set as EU region.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "example": "<REPLY_TO_EMAIL>" } } } @@ -36077,7 +36019,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -36085,31 +36027,31 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "templateId": { "type": "string", "description": "Msg91 template ID", "default": "", - "x-example": "<TEMPLATE_ID>" + "example": "<TEMPLATE_ID>" }, "senderId": { "type": "string", "description": "Msg91 sender ID.", "default": "", - "x-example": "<SENDER_ID>" + "example": "<SENDER_ID>" }, "authKey": { "type": "string", "description": "Msg91 auth key.", "default": "", - "x-example": "<AUTH_KEY>" + "example": "<AUTH_KEY>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -36176,7 +36118,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -36191,31 +36133,31 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "templateId": { "type": "string", "description": "Msg91 template ID.", "default": "", - "x-example": "<TEMPLATE_ID>" + "example": "<TEMPLATE_ID>" }, "senderId": { "type": "string", "description": "Msg91 sender ID.", "default": "", - "x-example": "<SENDER_ID>" + "example": "<SENDER_ID>" }, "authKey": { "type": "string", "description": "Msg91 auth key.", "default": "", - "x-example": "<AUTH_KEY>" + "example": "<AUTH_KEY>" } } } @@ -36280,7 +36222,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -36288,45 +36230,45 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "apiKey": { "type": "string", "description": "Resend API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -36393,7 +36335,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -36408,44 +36350,44 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "apiKey": { "type": "string", "description": "Resend API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "example": "<REPLY_TO_EMAIL>" } } } @@ -36510,7 +36452,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -36518,45 +36460,45 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "apiKey": { "type": "string", "description": "Sendgrid API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -36623,7 +36565,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -36638,44 +36580,44 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "apiKey": { "type": "string", "description": "Sendgrid API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "example": "<REPLY_TO_EMAIL>" } } } @@ -36740,7 +36682,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -36748,57 +36690,57 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "accessKey": { "type": "string", "description": "AWS access key ID.", "default": "", - "x-example": "<ACCESS_KEY>" + "example": "<ACCESS_KEY>" }, "secretKey": { "type": "string", "description": "AWS secret access key.", "default": "", - "x-example": "<SECRET_KEY>" + "example": "<SECRET_KEY>" }, "region": { "type": "string", "description": "AWS region, for example us-east-1.", "default": "", - "x-example": "<REGION>" + "example": "<REGION>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -36865,7 +36807,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -36880,56 +36822,56 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "accessKey": { "type": "string", "description": "AWS access key ID.", "default": "", - "x-example": "<ACCESS_KEY>" + "example": "<ACCESS_KEY>" }, "secretKey": { "type": "string", "description": "AWS secret access key.", "default": "", - "x-example": "<SECRET_KEY>" + "example": "<SECRET_KEY>" }, "region": { "type": "string", "description": "AWS region, for example us-east-1.", "default": "", - "x-example": "<REGION>" + "example": "<REGION>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "example": "<REPLY_TO_EMAIL>" } } } @@ -37080,7 +37022,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -37088,37 +37030,37 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "host": { "type": "string", "description": "SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.", - "x-example": "<HOST>" + "example": "<HOST>" }, "port": { "type": "integer", "description": "The default SMTP server port.", "default": 587, - "x-example": 1, + "example": 1, "format": "int32" }, "username": { "type": "string", "description": "Authentication username.", "default": "", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "password": { "type": "string", "description": "Authentication password.", "default": "", - "x-example": "password", + "example": "password", "format": "password" }, "encryption": { "type": "string", "description": "Encryption type. Can be omitted, 'ssl', or 'tls'", - "x-example": "none", + "example": "none", "enum": [ "none", "ssl", @@ -37135,45 +37077,45 @@ "type": "boolean", "description": "Enable SMTP AutoTLS feature.", "default": true, - "x-example": false + "example": false }, "mailer": { "type": "string", "description": "The value to use for the X-Mailer header.", "default": "", - "x-example": "<MAILER>" + "example": "<MAILER>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -37323,7 +37265,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -37338,38 +37280,38 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "host": { "type": "string", "description": "SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.", "default": "", - "x-example": "<HOST>" + "example": "<HOST>" }, "port": { "type": "integer", "description": "SMTP port.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "username": { "type": "string", "description": "Authentication username.", "default": "", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "password": { "type": "string", "description": "Authentication password.", "default": "", - "x-example": "password", + "example": "password", "format": "password" }, "encryption": { "type": "string", "description": "Encryption type. Can be 'ssl' or 'tls'", - "x-example": "none", + "example": "none", "enum": [ "none", "ssl", @@ -37385,45 +37327,45 @@ "autoTLS": { "type": "boolean", "description": "Enable SMTP AutoTLS feature.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "mailer": { "type": "string", "description": "The value to use for the X-Mailer header.", "default": "", - "x-example": "<MAILER>" + "example": "<MAILER>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "example": "<REPLY_TO_EMAIL>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -37488,7 +37430,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -37496,32 +37438,32 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "from": { "type": "string", "description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "customerId": { "type": "string", "description": "Telesign customer ID.", "default": "", - "x-example": "<CUSTOMER_ID>" + "example": "<CUSTOMER_ID>" }, "apiKey": { "type": "string", "description": "Telesign API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -37588,7 +37530,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -37603,31 +37545,31 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "customerId": { "type": "string", "description": "Telesign customer ID.", "default": "", - "x-example": "<CUSTOMER_ID>" + "example": "<CUSTOMER_ID>" }, "apiKey": { "type": "string", "description": "Telesign API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "from": { "type": "string", "description": "Sender number.", "default": "", - "x-example": "<FROM>" + "example": "<FROM>" } } } @@ -37692,7 +37634,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -37700,32 +37642,32 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "from": { "type": "string", "description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "username": { "type": "string", "description": "Textmagic username.", "default": "", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "apiKey": { "type": "string", "description": "Textmagic apiKey.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -37792,7 +37734,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -37807,31 +37749,31 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "username": { "type": "string", "description": "Textmagic username.", "default": "", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "apiKey": { "type": "string", "description": "Textmagic apiKey.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "from": { "type": "string", "description": "Sender number.", "default": "", - "x-example": "<FROM>" + "example": "<FROM>" } } } @@ -37896,7 +37838,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -37904,32 +37846,32 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "from": { "type": "string", "description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "accountSid": { "type": "string", "description": "Twilio account secret ID.", "default": "", - "x-example": "<ACCOUNT_SID>" + "example": "<ACCOUNT_SID>" }, "authToken": { "type": "string", "description": "Twilio authentication token.", "default": "", - "x-example": "<AUTH_TOKEN>" + "example": "<AUTH_TOKEN>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -37996,7 +37938,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -38011,31 +37953,31 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "accountSid": { "type": "string", "description": "Twilio account secret ID.", "default": "", - "x-example": "<ACCOUNT_SID>" + "example": "<ACCOUNT_SID>" }, "authToken": { "type": "string", "description": "Twilio authentication token.", "default": "", - "x-example": "<AUTH_TOKEN>" + "example": "<AUTH_TOKEN>" }, "from": { "type": "string", "description": "Sender number.", "default": "", - "x-example": "<FROM>" + "example": "<FROM>" } } } @@ -38100,7 +38042,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -38108,32 +38050,32 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "from": { "type": "string", "description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "apiKey": { "type": "string", "description": "Vonage API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "apiSecret": { "type": "string", "description": "Vonage API secret.", "default": "", - "x-example": "<API_SECRET>" + "example": "<API_SECRET>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -38200,7 +38142,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -38215,31 +38157,31 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "apiKey": { "type": "string", "description": "Vonage API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "apiSecret": { "type": "string", "description": "Vonage API secret.", "default": "", - "x-example": "<API_SECRET>" + "example": "<API_SECRET>" }, "from": { "type": "string", "description": "Sender number.", "default": "", - "x-example": "<FROM>" + "example": "<FROM>" } } } @@ -38302,7 +38244,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -38354,7 +38296,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -38428,7 +38370,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -38439,7 +38381,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -38501,7 +38443,7 @@ "topicId": { "type": "string", "description": "Topic ID. Choose a custom Topic ID or a new Topic ID.", - "x-example": "<TOPIC_ID>", + "example": "<TOPIC_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -38509,7 +38451,7 @@ "name": { "type": "string", "description": "Topic Name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "subscribe": { "type": "array", @@ -38517,7 +38459,9 @@ "default": [ "users" ], - "x-example": "[\"any\"]", + "example": [ + "any" + ], "items": { "type": "string" } @@ -38587,7 +38531,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" } @@ -38646,7 +38590,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" } @@ -38660,17 +38604,19 @@ "name": { "type": "string", "description": "Topic Name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "subscribe": { "type": "array", "description": "An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.", - "x-example": "[\"any\"]", + "example": [ + "any" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true } } } @@ -38724,7 +38670,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" } @@ -38785,7 +38731,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" }, @@ -38808,7 +38754,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -38819,7 +38765,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -38882,7 +38828,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" } @@ -38896,7 +38842,7 @@ "subscriberId": { "type": "string", "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", - "x-example": "<SUBSCRIBER_ID>", + "example": "<SUBSCRIBER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -38904,7 +38850,7 @@ "targetId": { "type": "string", "description": "Target ID. The target ID to link to the specified Topic ID.", - "x-example": "<TARGET_ID>" + "example": "<TARGET_ID>" } }, "required": [ @@ -38971,7 +38917,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" }, @@ -38981,7 +38927,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SUBSCRIBER_ID>" + "example": "<SUBSCRIBER_ID>" }, "in": "path" } @@ -39036,7 +38982,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" }, @@ -39046,7 +38992,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SUBSCRIBER_ID>" + "example": "<SUBSCRIBER_ID>" }, "in": "path" } @@ -39118,7 +39064,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -39129,7 +39075,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -39191,7 +39137,6 @@ "resources": { "type": "array", "description": "List of resources to migrate", - "x-example": null, "items": { "type": "string", "enum": [ @@ -39282,24 +39227,24 @@ "endpoint": { "type": "string", "description": "Source Appwrite endpoint", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "projectId": { "type": "string", "description": "Source Project ID", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "apiKey": { "type": "string", "description": "Source API Key", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "onDuplicate": { "type": "string", "description": "Behavior when a row with an existing $id is encountered. \"fail\" (default): abort on first conflict. \"skip\": silently ignore. \"overwrite\": replace existing row.", "default": "fail", - "x-example": "fail", + "example": "fail", "enum": [ "fail", "skip", @@ -39473,7 +39418,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" }, @@ -39483,7 +39428,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "query" }, @@ -39493,7 +39438,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY>" + "example": "<KEY>" }, "in": "query" } @@ -39554,23 +39499,22 @@ "databaseId": { "type": "string", "description": "Database ID containing the source collection.", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "collectionId": { "type": "string", "description": "Collection ID to export documents from.", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "filename": { "type": "string", "description": "The name of the file to be created for the export, excluding the .csv extension.", - "x-example": "<FILENAME>" + "example": "<FILENAME>" }, "columns": { "type": "array", "description": "List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -39579,7 +39523,6 @@ "type": "array", "description": "Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -39588,31 +39531,31 @@ "type": "string", "description": "The character that separates each column value. Default is comma.", "default": ",", - "x-example": "<DELIMITER>" + "example": "<DELIMITER>" }, "enclosure": { "type": "string", "description": "The character that encloses each column value. Default is double quotes.", "default": "\"", - "x-example": "<ENCLOSURE>" + "example": "<ENCLOSURE>" }, "escape": { "type": "string", "description": "The escape character for the enclosure character. Default is double quotes.", "default": "\"", - "x-example": "<ESCAPE>" + "example": "<ESCAPE>" }, "header": { "type": "boolean", "description": "Whether to include the header row with column names. Default is true.", "default": true, - "x-example": false + "example": false }, "notify": { "type": "boolean", "description": "Set to true to receive an email when the export is complete. Default is true.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -39680,34 +39623,34 @@ "bucketId": { "type": "string", "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "fileId": { "type": "string", "description": "File ID.", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "databaseId": { "type": "string", "description": "Database ID containing the target collection.", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "collectionId": { "type": "string", "description": "Collection ID to import documents into.", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "internalFile": { "type": "boolean", "description": "Is the file stored in an internal bucket?", "default": false, - "x-example": false + "example": false }, "onDuplicate": { "type": "string", "description": "Behavior when a row with an existing $id is encountered. \"fail\" (default): abort on first conflict. \"skip\": silently ignore. \"overwrite\": replace existing row.", "default": "fail", - "x-example": "fail", + "example": "fail", "enum": [ "fail", "skip", @@ -39787,7 +39730,6 @@ "resources": { "type": "array", "description": "List of resources to migrate", - "x-example": null, "items": { "type": "string", "enum": [ @@ -39820,7 +39762,7 @@ "serviceAccount": { "type": "string", "description": "JSON of the Firebase service account credentials", - "x-example": "<SERVICE_ACCOUNT>" + "example": "<SERVICE_ACCOUNT>" } }, "required": [ @@ -39922,7 +39864,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SERVICE_ACCOUNT>" + "example": "<SERVICE_ACCOUNT>" }, "in": "query" } @@ -39983,23 +39925,22 @@ "databaseId": { "type": "string", "description": "Database ID containing the source collection.", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "collectionId": { "type": "string", "description": "Collection ID to export documents from.", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "filename": { "type": "string", "description": "The name of the file to be created for the export, excluding the .json extension.", - "x-example": "<FILENAME>" + "example": "<FILENAME>" }, "columns": { "type": "array", "description": "List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -40008,7 +39949,6 @@ "type": "array", "description": "Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -40017,7 +39957,7 @@ "type": "boolean", "description": "Set to true to receive an email when the export is complete. Default is true.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -40085,34 +40025,34 @@ "bucketId": { "type": "string", "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "fileId": { "type": "string", "description": "File ID.", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "databaseId": { "type": "string", "description": "Database ID containing the target collection.", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "collectionId": { "type": "string", "description": "Collection ID to import documents into.", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "internalFile": { "type": "boolean", "description": "Is the file stored in an internal bucket?", "default": false, - "x-example": false + "example": false }, "onDuplicate": { "type": "string", "description": "Behavior when a row with an existing $id is encountered. \"fail\" (default): abort on first conflict. \"skip\": silently ignore. \"overwrite\": replace existing row.", "default": "fail", - "x-example": "fail", + "example": "fail", "enum": [ "fail", "skip", @@ -40192,7 +40132,6 @@ "resources": { "type": "array", "description": "List of resources to migrate", - "x-example": null, "items": { "type": "string", "enum": [ @@ -40227,39 +40166,38 @@ "subdomain": { "type": "string", "description": "Source's Subdomain", - "x-example": "<SUBDOMAIN>" + "example": "<SUBDOMAIN>" }, "region": { "type": "string", "description": "Source's Region", - "x-example": "<REGION>" + "example": "<REGION>" }, "adminSecret": { "type": "string", "description": "Source's Admin Secret", - "x-example": "<ADMIN_SECRET>" + "example": "<ADMIN_SECRET>" }, "database": { "type": "string", "description": "Source's Database Name", - "x-example": "<DATABASE>" + "example": "<DATABASE>" }, "username": { "type": "string", "description": "Source's Database Username", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "password": { "type": "string", "description": "Source's Database Password", - "x-example": "password", + "example": "password", "format": "password" }, "port": { "type": "integer", "description": "Source's Database Port", "default": 5432, - "x-example": null, "format": "int32" } }, @@ -40369,7 +40307,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SUBDOMAIN>" + "example": "<SUBDOMAIN>" }, "in": "query" }, @@ -40379,7 +40317,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<REGION>" + "example": "<REGION>" }, "in": "query" }, @@ -40389,7 +40327,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ADMIN_SECRET>" + "example": "<ADMIN_SECRET>" }, "in": "query" }, @@ -40399,7 +40337,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE>" + "example": "<DATABASE>" }, "in": "query" }, @@ -40409,7 +40347,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "in": "query" }, @@ -40420,7 +40358,7 @@ "schema": { "type": "string", "format": "password", - "x-example": "password" + "example": "password" }, "in": "query" }, @@ -40492,7 +40430,6 @@ "resources": { "type": "array", "description": "List of resources to migrate", - "x-example": null, "items": { "type": "string", "enum": [ @@ -40527,35 +40464,34 @@ "endpoint": { "type": "string", "description": "Source's Supabase Endpoint", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "apiKey": { "type": "string", "description": "Source's API Key", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "databaseHost": { "type": "string", "description": "Source's Database Host", - "x-example": "<DATABASE_HOST>" + "example": "<DATABASE_HOST>" }, "username": { "type": "string", "description": "Source's Database Username", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "password": { "type": "string", "description": "Source's Database Password", - "x-example": "password", + "example": "password", "format": "password" }, "port": { "type": "integer", "description": "Source's Database Port", "default": 5432, - "x-example": null, "format": "int32" } }, @@ -40665,7 +40601,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" }, @@ -40675,7 +40611,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "in": "query" }, @@ -40685,7 +40621,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_HOST>" + "example": "<DATABASE_HOST>" }, "in": "query" }, @@ -40695,7 +40631,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "in": "query" }, @@ -40706,7 +40642,7 @@ "schema": { "type": "string", "format": "password", - "x-example": "password" + "example": "password" }, "in": "query" }, @@ -40776,7 +40712,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MIGRATION_ID>" + "example": "<MIGRATION_ID>" }, "in": "path" } @@ -40833,7 +40769,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MIGRATION_ID>" + "example": "<MIGRATION_ID>" }, "in": "path" } @@ -40883,7 +40819,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MIGRATION_ID>" + "example": "<MIGRATION_ID>" }, "in": "path" } @@ -41006,7 +40942,7 @@ "databaseId": { "type": "string", "description": "Database ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -41014,87 +40950,86 @@ "name": { "type": "string", "description": "Database display name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "version": { "type": "string", "description": "Database engine version. Defaults to latest for selected engine.", - "x-example": "17", - "x-nullable": true + "example": "17", + "nullable": true }, "specification": { "type": "string", "description": "Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.", "default": "s-1vcpu-1gb", - "x-example": "<SPECIFICATION>" + "example": "<SPECIFICATION>" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds.", "default": 900, - "x-example": 60, + "example": 60, "format": "int32" }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes of inactivity before container scales to zero.", "default": 15, - "x-example": 5, + "example": 5, "format": "int32" }, "pitr": { "type": "boolean", "description": "Enable point-in-time recovery (PITR). Continuously archives changes so the database can be restored to any moment within the retention window.", "default": true, - "x-example": false + "example": false }, "pitrRetentionDays": { "type": "integer", "description": "Number of days to retain PITR data.", "default": 7, - "x-example": 1, + "example": 1, "format": "int32" }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", "default": false, - "x-example": false + "example": false }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", "default": 85, - "x-example": 50, + "example": 50, "format": "int32" }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -41209,7 +41144,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41267,7 +41202,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41281,139 +41216,136 @@ "name": { "type": "string", "description": "Database display name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "status": { "type": "string", "description": "Database status. Allowed values: ready, paused, inactive. Set to \"paused\" to pause, \"ready\" to resume (also recovers a failed database whose infrastructure is healthy), or \"inactive\" to spin down a shared-pool database.", - "x-example": "ready", - "x-nullable": true + "example": "ready", + "nullable": true }, "specification": { "type": "string", "description": "Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds (60-86400).", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes before container scales to zero.", - "x-example": 5, + "example": 5, "format": "int32", - "x-nullable": true + "nullable": true }, "pitr": { "type": "boolean", "description": "Enable or disable point-in-time recovery (PITR).", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "pitrRetentionDays": { "type": "integer", "description": "Days to retain PITR data.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", - "x-example": 50, + "example": 50, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "metricsTraceSampleRate": { "type": "number", "description": "Fraction of queries to trace (0.0\u20131.0). Forwarded to the sidecar.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "metricsSlowQueryLogThresholdMs": { "type": "integer", "description": "Threshold in ms above which queries are logged as slow. Forwarded to the sidecar.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiEnabled": { "type": "boolean", "description": "Enable the SQL API sidecar for this database.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "sqlApiAllowedStatements": { "type": "array", "description": "Statement types the SQL API accepts. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "sqlApiMaxRows": { "type": "integer", "description": "Maximum rows returned per SQL API execution (1-1000000).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiMaxBytes": { "type": "integer", "description": "Maximum serialised SQL API result payload in bytes (1024-104857600).", - "x-example": 1024, + "example": 1024, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiTimeoutSeconds": { "type": "integer", "description": "Per-call SQL API execution timeout in seconds (1-300).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } } } @@ -41469,7 +41401,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41529,7 +41461,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -41600,7 +41532,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41615,7 +41547,7 @@ "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" } } } @@ -41677,7 +41609,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -41748,7 +41680,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41762,7 +41694,7 @@ "policyId": { "type": "string", "description": "Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<POLICY_ID>", + "example": "<POLICY_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -41770,30 +41702,29 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32" }, "type": { "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -41861,7 +41792,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -41871,7 +41802,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -41929,7 +41860,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -41939,7 +41870,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -41953,26 +41884,25 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -42028,7 +41958,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -42038,7 +41968,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -42098,7 +42028,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -42112,40 +42042,40 @@ "provider": { "type": "string", "description": "Storage provider for off-cluster backups. Allowed values: s3 (Amazon S3 or S3-compatible), gcs (Google Cloud Storage), azure (Azure Blob Storage).", - "x-example": "s3" + "example": "s3" }, "bucket": { "type": "string", "description": "Storage bucket or container name.", - "x-example": "<BUCKET>" + "example": "<BUCKET>" }, "region": { "type": "string", "description": "Storage region.", "default": "", - "x-example": "<REGION>" + "example": "<REGION>" }, "prefix": { "type": "string", "description": "Object key prefix for backups.", "default": "backups\/", - "x-example": "<PREFIX>" + "example": "<PREFIX>" }, "endpoint": { "type": "string", "description": "Custom endpoint for S3-compatible storage (e.g. MinIO).", "default": "", - "x-example": "<ENDPOINT>" + "example": "<ENDPOINT>" }, "accessKey": { "type": "string", "description": "Access key or client ID for authentication.", - "x-example": "<ACCESS_KEY>" + "example": "<ACCESS_KEY>" }, "secretKey": { "type": "string", "description": "Secret key or service account JSON for authentication.", - "x-example": "<SECRET_KEY>" + "example": "<SECRET_KEY>" } }, "required": [ @@ -42213,7 +42143,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -42223,7 +42153,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -42277,7 +42207,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -42287,7 +42217,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -42347,7 +42277,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -42405,7 +42335,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -42420,7 +42350,7 @@ "type": "string", "description": "Branch ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": "", - "x-example": "<BRANCH_ID>", + "example": "<BRANCH_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -42429,7 +42359,7 @@ "type": "integer", "description": "Time-to-live in seconds before the branch expires. Min 300 (5 min), max 604800 (7 days). Default: 86400 (24h).", "default": 86400, - "x-example": 300, + "example": 300, "format": "int32" } } @@ -42492,7 +42422,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -42502,7 +42432,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BRANCH_ID>" + "example": "<BRANCH_ID>" }, "in": "path" } @@ -42562,7 +42492,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -42622,7 +42552,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -42636,8 +42566,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -42699,7 +42629,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -42713,12 +42643,12 @@ "day": { "type": "string", "description": "Day of the week for the maintenance window. Allowed values: sun, mon, tue, wed, thu, fri, sat.", - "x-example": "sun" + "example": "sun" }, "hourUtc": { "type": "integer", "description": "Hour in UTC (0-23) for maintenance window start.", - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -42785,7 +42715,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -42799,13 +42729,13 @@ "targetType": { "type": "string", "description": "Target database type to migrate to. Allowed values: shared (serverless, scales to zero when idle), dedicated (always-on with persistent resources).", - "x-example": "shared" + "example": "shared" }, "specification": { "type": "string", "description": "Target specification to provision when migrating to dedicated. Ignored for shared. Defaults to the database's current specification.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true } }, "required": [ @@ -42870,7 +42800,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -42880,7 +42810,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -42891,7 +42821,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -42903,7 +42833,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -42964,7 +42894,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -43024,7 +42954,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -43084,7 +43014,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -43094,7 +43024,7 @@ "required": false, "schema": { "type": "string", - "x-example": "pending" + "example": "pending" }, "in": "query" }, @@ -43104,7 +43034,7 @@ "required": false, "schema": { "type": "string", - "x-example": "backup" + "example": "backup" }, "in": "query" }, @@ -43115,7 +43045,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -43127,7 +43057,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -43186,7 +43116,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -43201,26 +43131,26 @@ "type": "string", "description": "Restoration type. Allowed values: backup, pitr. Use \"backup\" to restore from a specific backup, or \"pitr\" for point-in-time recovery.", "default": "backup", - "x-example": "backup" + "example": "backup" }, "backupId": { "type": "string", "description": "Backup ID to restore from (required for backup type).", - "x-example": "<BACKUP_ID>", - "x-nullable": true + "example": "<BACKUP_ID>", + "nullable": true }, "targetDatabaseId": { "type": "string", "description": "Existing database ID to restore into. The target must be distinct, ready, and use the same engine and version.", - "x-example": "<TARGET_DATABASE_ID>", - "x-nullable": true + "example": "<TARGET_DATABASE_ID>", + "nullable": true }, "targetTime": { "type": "string", "description": "Target time for PITR (required for pitr type) as an [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -43282,7 +43212,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -43292,7 +43222,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RESTORATION_ID>" + "example": "<RESTORATION_ID>" }, "in": "path" } @@ -43352,7 +43282,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -43412,7 +43342,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -43426,7 +43356,7 @@ "targetVersion": { "type": "string", "description": "Target engine version to upgrade to.", - "x-example": "<TARGET_VERSION>" + "example": "<TARGET_VERSION>" } }, "required": [ @@ -43554,7 +43484,7 @@ "databaseId": { "type": "string", "description": "Database ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -43562,87 +43492,86 @@ "name": { "type": "string", "description": "Database display name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "version": { "type": "string", "description": "Database engine version. Defaults to latest for selected engine.", - "x-example": "17", - "x-nullable": true + "example": "17", + "nullable": true }, "specification": { "type": "string", "description": "Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.", "default": "s-1vcpu-1gb", - "x-example": "<SPECIFICATION>" + "example": "<SPECIFICATION>" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds.", "default": 900, - "x-example": 60, + "example": 60, "format": "int32" }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes of inactivity before container scales to zero.", "default": 15, - "x-example": 5, + "example": 5, "format": "int32" }, "pitr": { "type": "boolean", "description": "Enable point-in-time recovery (PITR). Continuously archives changes so the database can be restored to any moment within the retention window.", "default": true, - "x-example": false + "example": false }, "pitrRetentionDays": { "type": "integer", "description": "Number of days to retain PITR data.", "default": 7, - "x-example": 1, + "example": 1, "format": "int32" }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", "default": false, - "x-example": false + "example": false }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", "default": 85, - "x-example": 50, + "example": 50, "format": "int32" }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -43757,7 +43686,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -43815,7 +43744,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -43829,139 +43758,136 @@ "name": { "type": "string", "description": "Database display name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "status": { "type": "string", "description": "Database status. Allowed values: ready, paused, inactive. Set to \"paused\" to pause, \"ready\" to resume (also recovers a failed database whose infrastructure is healthy), or \"inactive\" to spin down a shared-pool database.", - "x-example": "ready", - "x-nullable": true + "example": "ready", + "nullable": true }, "specification": { "type": "string", "description": "Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds (60-86400).", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes before container scales to zero.", - "x-example": 5, + "example": 5, "format": "int32", - "x-nullable": true + "nullable": true }, "pitr": { "type": "boolean", "description": "Enable or disable point-in-time recovery (PITR).", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "pitrRetentionDays": { "type": "integer", "description": "Days to retain PITR data.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", - "x-example": 50, + "example": 50, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "metricsTraceSampleRate": { "type": "number", "description": "Fraction of queries to trace (0.0\u20131.0). Forwarded to the sidecar.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "metricsSlowQueryLogThresholdMs": { "type": "integer", "description": "Threshold in ms above which queries are logged as slow. Forwarded to the sidecar.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiEnabled": { "type": "boolean", "description": "Enable the SQL API sidecar for this database.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "sqlApiAllowedStatements": { "type": "array", "description": "Statement types the SQL API accepts. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "sqlApiMaxRows": { "type": "integer", "description": "Maximum rows returned per SQL API execution (1-1000000).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiMaxBytes": { "type": "integer", "description": "Maximum serialised SQL API result payload in bytes (1024-104857600).", - "x-example": 1024, + "example": 1024, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiTimeoutSeconds": { "type": "integer", "description": "Per-call SQL API execution timeout in seconds (1-300).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } } } @@ -44017,7 +43943,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -44077,7 +44003,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -44148,7 +44074,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -44163,7 +44089,7 @@ "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" } } } @@ -44225,7 +44151,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -44296,7 +44222,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -44310,7 +44236,7 @@ "policyId": { "type": "string", "description": "Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<POLICY_ID>", + "example": "<POLICY_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -44318,30 +44244,29 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32" }, "type": { "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -44409,7 +44334,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -44419,7 +44344,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -44477,7 +44402,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -44487,7 +44412,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -44501,26 +44426,25 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44576,7 +44500,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -44586,7 +44510,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -44646,7 +44570,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -44660,40 +44584,40 @@ "provider": { "type": "string", "description": "Storage provider for off-cluster backups. Allowed values: s3 (Amazon S3 or S3-compatible), gcs (Google Cloud Storage), azure (Azure Blob Storage).", - "x-example": "s3" + "example": "s3" }, "bucket": { "type": "string", "description": "Storage bucket or container name.", - "x-example": "<BUCKET>" + "example": "<BUCKET>" }, "region": { "type": "string", "description": "Storage region.", "default": "", - "x-example": "<REGION>" + "example": "<REGION>" }, "prefix": { "type": "string", "description": "Object key prefix for backups.", "default": "backups\/", - "x-example": "<PREFIX>" + "example": "<PREFIX>" }, "endpoint": { "type": "string", "description": "Custom endpoint for S3-compatible storage (e.g. MinIO).", "default": "", - "x-example": "<ENDPOINT>" + "example": "<ENDPOINT>" }, "accessKey": { "type": "string", "description": "Access key or client ID for authentication.", - "x-example": "<ACCESS_KEY>" + "example": "<ACCESS_KEY>" }, "secretKey": { "type": "string", "description": "Secret key or service account JSON for authentication.", - "x-example": "<SECRET_KEY>" + "example": "<SECRET_KEY>" } }, "required": [ @@ -44761,7 +44685,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -44771,7 +44695,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -44825,7 +44749,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -44835,7 +44759,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -44895,7 +44819,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -44953,7 +44877,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -44968,7 +44892,7 @@ "type": "string", "description": "Branch ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": "", - "x-example": "<BRANCH_ID>", + "example": "<BRANCH_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -44977,7 +44901,7 @@ "type": "integer", "description": "Time-to-live in seconds before the branch expires. Min 300 (5 min), max 604800 (7 days). Default: 86400 (24h).", "default": 86400, - "x-example": 300, + "example": 300, "format": "int32" } } @@ -45040,7 +44964,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -45050,7 +44974,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BRANCH_ID>" + "example": "<BRANCH_ID>" }, "in": "path" } @@ -45110,7 +45034,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -45170,7 +45094,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -45184,21 +45108,21 @@ "sql": { "type": "string", "description": "SQL statement to execute. Exactly one statement per request.", - "x-example": "<SQL>" + "example": "<SQL>" }, "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 + "example": {}, + "nullable": true }, "timeoutSeconds": { "type": "integer", "description": "Per-call execution timeout override. Must be less than or equal to the database's configured sqlApiTimeoutSeconds.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } }, "required": [ @@ -45263,7 +45187,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -45277,8 +45201,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -45340,7 +45264,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -45354,12 +45278,12 @@ "day": { "type": "string", "description": "Day of the week for the maintenance window. Allowed values: sun, mon, tue, wed, thu, fri, sat.", - "x-example": "sun" + "example": "sun" }, "hourUtc": { "type": "integer", "description": "Hour in UTC (0-23) for maintenance window start.", - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -45426,7 +45350,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -45440,13 +45364,13 @@ "targetType": { "type": "string", "description": "Target database type to migrate to. Allowed values: shared (serverless, scales to zero when idle), dedicated (always-on with persistent resources).", - "x-example": "shared" + "example": "shared" }, "specification": { "type": "string", "description": "Target specification to provision when migrating to dedicated. Ignored for shared. Defaults to the database's current specification.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true } }, "required": [ @@ -45511,7 +45435,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -45521,7 +45445,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -45532,7 +45456,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -45544,7 +45468,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -45605,7 +45529,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -45665,7 +45589,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -45723,7 +45647,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -45737,52 +45661,52 @@ "mode": { "type": "string", "description": "Connection pool mode. Allowed values: transaction, session. Transaction mode returns connections to the pool after each transaction; session mode holds connections for the entire session lifetime.", - "x-example": "transaction", - "x-nullable": true + "example": "transaction", + "nullable": true }, "maxConnections": { "type": "integer", "description": "Client-connection ceiling the pooler accepts. Supported on MySQL and MariaDB only; the PostgreSQL pooler has no client cap, so set networkMaxConnections on the database instead.", - "x-example": 10, + "example": 10, "format": "int32", - "x-nullable": true + "nullable": true }, "defaultPoolSize": { "type": "integer", "description": "Default pool size per user.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "readWriteSplitting": { "type": "boolean", "description": "Route SELECTs to HA replicas, writes and locked reads to the primary. Defaults to true when HA is enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "poolerCpuRequest": { "type": "string", "description": "Pooler sidecar CPU request override (Kubernetes quantity, e.g. \"250m\" or \"1\"). Leave null for the proportional default (5% of DB CPU, floor 100m).", - "x-example": "<POOLER_CPU_REQUEST>", - "x-nullable": true + "example": "<POOLER_CPU_REQUEST>", + "nullable": true }, "poolerCpuLimit": { "type": "string", "description": "Pooler sidecar CPU limit override (Kubernetes quantity, e.g. \"500m\" or \"1\"). Leave null for the proportional default (10% of DB CPU, floor 200m). Changing this field rolls the database pod.", - "x-example": "<POOLER_CPU_LIMIT>", - "x-nullable": true + "example": "<POOLER_CPU_LIMIT>", + "nullable": true }, "poolerMemoryRequest": { "type": "string", "description": "Pooler sidecar memory request override (Kubernetes quantity, e.g. \"128Mi\" or \"1Gi\"). Leave null for the proportional default (7.5% of DB memory, floor 64Mi).", - "x-example": "<POOLER_MEMORY_REQUEST>", - "x-nullable": true + "example": "<POOLER_MEMORY_REQUEST>", + "nullable": true }, "poolerMemoryLimit": { "type": "string", "description": "Pooler sidecar memory limit override (Kubernetes quantity, e.g. \"256Mi\" or \"1Gi\"). Leave null for the proportional default (15% of DB memory, floor 128Mi). Changing this field rolls the database pod.", - "x-example": "<POOLER_MEMORY_LIMIT>", - "x-nullable": true + "example": "<POOLER_MEMORY_LIMIT>", + "nullable": true } } } @@ -45844,7 +45768,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -45904,7 +45828,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -45914,7 +45838,7 @@ "required": false, "schema": { "type": "string", - "x-example": "pending" + "example": "pending" }, "in": "query" }, @@ -45924,7 +45848,7 @@ "required": false, "schema": { "type": "string", - "x-example": "backup" + "example": "backup" }, "in": "query" }, @@ -45935,7 +45859,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -45947,7 +45871,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -46006,7 +45930,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -46021,26 +45945,26 @@ "type": "string", "description": "Restoration type. Allowed values: backup, pitr. Use \"backup\" to restore from a specific backup, or \"pitr\" for point-in-time recovery.", "default": "backup", - "x-example": "backup" + "example": "backup" }, "backupId": { "type": "string", "description": "Backup ID to restore from (required for backup type).", - "x-example": "<BACKUP_ID>", - "x-nullable": true + "example": "<BACKUP_ID>", + "nullable": true }, "targetDatabaseId": { "type": "string", "description": "Existing database ID to restore into. The target must be distinct, ready, and use the same engine and version.", - "x-example": "<TARGET_DATABASE_ID>", - "x-nullable": true + "example": "<TARGET_DATABASE_ID>", + "nullable": true }, "targetTime": { "type": "string", "description": "Target time for PITR (required for pitr type) as an [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -46102,7 +46026,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -46112,7 +46036,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RESTORATION_ID>" + "example": "<RESTORATION_ID>" }, "in": "path" } @@ -46172,7 +46096,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -46232,7 +46156,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -46246,7 +46170,7 @@ "targetVersion": { "type": "string", "description": "Target engine version to upgrade to.", - "x-example": "<TARGET_VERSION>" + "example": "<TARGET_VERSION>" } }, "required": [ @@ -46372,7 +46296,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<NOTIFICATION_ID>" + "example": "<NOTIFICATION_ID>" }, "in": "path" } @@ -46386,7 +46310,7 @@ "read": { "type": "boolean", "description": "Notification read status.", - "x-example": false + "example": false } }, "required": [ @@ -46453,7 +46377,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -46467,19 +46391,19 @@ "grant_id": { "type": "string", "description": "Grant ID made during authorization, provided to consent screen in URL search params.", - "x-example": "<GRANT_ID>" + "example": "<GRANT_ID>" }, "authorization_details": { "type": "string", "description": "Enriched `authorization_details` the user consented to, replacing what the client requested. Each entry must use a `type` the project accepts. Optional; omit to keep the originally requested details.", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" }, "scope": { "type": "string", "description": "Space-separated scopes the user consented to. Must be a subset of the scopes originally requested; identity scopes such as `openid` are always retained. Optional; omit to keep the originally requested scopes.", "default": "", - "x-example": "<SCOPE>" + "example": "<SCOPE>" } }, "required": [ @@ -46546,7 +46470,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -46556,7 +46480,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<CLIENT_ID>", + "example": "<CLIENT_ID>", "default": "" }, "in": "query" @@ -46568,7 +46492,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -46579,7 +46503,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -46590,7 +46514,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SCOPE>", + "example": "<SCOPE>", "default": "" }, "in": "query" @@ -46601,7 +46525,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<STATE>", + "example": "<STATE>", "default": "" }, "in": "query" @@ -46612,7 +46536,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<NONCE>", + "example": "<NONCE>", "default": "" }, "in": "query" @@ -46623,7 +46547,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<CODE_CHALLENGE>", + "example": "<CODE_CHALLENGE>", "default": "" }, "in": "query" @@ -46634,7 +46558,7 @@ "required": false, "schema": { "type": "string", - "x-example": "s256", + "example": "s256", "default": "" }, "in": "query" @@ -46645,7 +46569,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<PROMPT>", + "example": "<PROMPT>", "default": "" }, "in": "query" @@ -46657,7 +46581,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0 + "example": 0 }, "in": "query" }, @@ -46667,7 +46591,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<AUTHORIZATION_DETAILS>", + "example": "<AUTHORIZATION_DETAILS>", "default": "" }, "in": "query" @@ -46688,7 +46612,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<AUDIENCE>", + "example": "<AUDIENCE>", "default": "" }, "in": "query" @@ -46699,7 +46623,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<REQUEST_URI>", + "example": "<REQUEST_URI>", "default": "" }, "in": "query" @@ -46760,7 +46684,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -46775,87 +46699,86 @@ "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "redirect_uri": { "type": "string", "description": "Redirect URI where visitor will be redirected after authorization, whether successful or not.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "response_type": { "type": "string", "description": "OAuth2 \/ OIDC response type. One of `code` (Authorization Code Flow), `id_token` (Implicit Flow, OIDC login only), or `code id_token` (Hybrid Flow).", "default": "", - "x-example": "" + "example": "" }, "scope": { "type": "string", "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`, `phone`.", "default": "", - "x-example": "<SCOPE>" + "example": "<SCOPE>" }, "state": { "type": "string", "description": "OAuth2 state. You receive this back in the redirect URI.", "default": "", - "x-example": "<STATE>" + "example": "<STATE>" }, "nonce": { "type": "string", "description": "OIDC nonce parameter to prevent replay attacks. Required when response_type includes `id_token`.", "default": "", - "x-example": "<NONCE>" + "example": "<NONCE>" }, "code_challenge": { "type": "string", "description": "PKCE code challenge. Required when OAuth2 app is public.", "default": "", - "x-example": "<CODE_CHALLENGE>" + "example": "<CODE_CHALLENGE>" }, "code_challenge_method": { "type": "string", "description": "PKCE code challenge method. Required when OAuth2 app is public.", "default": "", - "x-example": "s256" + "example": "s256" }, "prompt": { "type": "string", "description": "OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.", "default": "", - "x-example": "<PROMPT>" + "example": "<PROMPT>" }, "max_age": { "type": "integer", "description": "OIDC max_age paraleter for customization of consent screen. Maximum allowable elapsed time in seconds since the user last authenticated. If exceeded, re-authentication is required.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "authorization_details": { "type": "string", "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "<AUDIENCE>" + "example": "<AUDIENCE>" }, "request_uri": { "type": "string", "description": "OAuth2 authorization request handle returned by the pushed authorization request endpoint.", "default": "", - "x-example": "<REQUEST_URI>" + "example": "<REQUEST_URI>" } } } @@ -46920,7 +46843,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -46935,31 +46858,30 @@ "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "scope": { "type": "string", "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`.", "default": "", - "x-example": "<SCOPE>" + "example": "<SCOPE>" }, "authorization_details": { "type": "string", "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "<AUDIENCE>" + "example": "<AUDIENCE>" } } } @@ -47023,7 +46945,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -47037,7 +46959,7 @@ "user_code": { "type": "string", "description": "User code displayed on the device.", - "x-example": "<USER_CODE>" + "example": "<USER_CODE>" } }, "required": [ @@ -47105,7 +47027,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -47115,7 +47037,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<GRANT_ID>" + "example": "<GRANT_ID>" }, "in": "path" } @@ -47171,7 +47093,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -47181,7 +47103,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<ID_TOKEN_HINT>", + "example": "<ID_TOKEN_HINT>", "default": "" }, "in": "query" @@ -47192,7 +47114,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<LOGOUT_HINT>", + "example": "<LOGOUT_HINT>", "default": "" }, "in": "query" @@ -47203,7 +47125,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<CLIENT_ID>", + "example": "<CLIENT_ID>", "default": "" }, "in": "query" @@ -47215,7 +47137,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -47226,7 +47148,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<STATE>", + "example": "<STATE>", "default": "" }, "in": "query" @@ -47237,7 +47159,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<UI_LOCALES>", + "example": "<UI_LOCALES>", "default": "" }, "in": "query" @@ -47292,7 +47214,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -47307,38 +47229,38 @@ "type": "string", "description": "ID Token previously issued to the app, used as proof of the logout request. Required to end the session; signature and issuer are validated while expiry is ignored.", "default": "", - "x-example": "<ID_TOKEN_HINT>" + "example": "<ID_TOKEN_HINT>" }, "logout_hint": { "type": "string", "description": "Hint about the user that is logging out. Accepted for OIDC compatibility.", "default": "", - "x-example": "<LOGOUT_HINT>" + "example": "<LOGOUT_HINT>" }, "client_id": { "type": "string", "description": "OAuth2 client ID. When both `client_id` and `id_token_hint` are provided, they must identify the same app.", "default": "", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "post_logout_redirect_uri": { "type": "string", "description": "URI to redirect the user to after logout. Must exactly match a URI registered in the app's `postLogoutRedirectUris`.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "state": { "type": "string", "description": "Opaque value passed back unchanged in the `state` query param of the post-logout redirect.", "default": "", - "x-example": "<STATE>" + "example": "<STATE>" }, "ui_locales": { "type": "string", "description": "Preferred languages for any logout UI, as space-separated BCP47 tags. Accepted for OIDC compatibility.", "default": "", - "x-example": "<UI_LOCALES>" + "example": "<UI_LOCALES>" } } } @@ -47403,7 +47325,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -47414,7 +47336,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -47426,7 +47348,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -47437,7 +47359,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -47501,7 +47423,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -47515,79 +47437,78 @@ "client_id": { "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "redirect_uri": { "type": "string", "description": "Redirect URI where visitor will be redirected after authorization, whether successful or not.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "response_type": { "type": "string", "description": "OAuth2 \/ OIDC response type.", - "x-example": "code" + "example": "code" }, "scope": { "type": "string", "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`, `phone`.", "default": "", - "x-example": "<SCOPE>" + "example": "<SCOPE>" }, "state": { "type": "string", "description": "OAuth2 state. You receive this back in the redirect URI.", "default": "", - "x-example": "<STATE>" + "example": "<STATE>" }, "nonce": { "type": "string", "description": "OIDC nonce parameter to prevent replay attacks. Required when response_type includes `id_token`.", "default": "", - "x-example": "<NONCE>" + "example": "<NONCE>" }, "code_challenge": { "type": "string", "description": "PKCE code challenge. Required when OAuth2 app is public.", "default": "", - "x-example": "<CODE_CHALLENGE>" + "example": "<CODE_CHALLENGE>" }, "code_challenge_method": { "type": "string", "description": "PKCE code challenge method. Required when OAuth2 app is public.", "default": "", - "x-example": "s256" + "example": "s256" }, "prompt": { "type": "string", "description": "OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.", "default": "", - "x-example": "<PROMPT>" + "example": "<PROMPT>" }, "max_age": { "type": "integer", "description": "OIDC max_age parameter for customization of consent screen.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "authorization_details": { "type": "string", "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "<AUDIENCE>" + "example": "<AUDIENCE>" } }, "required": [ @@ -47657,7 +47578,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -47668,7 +47589,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -47680,7 +47601,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -47691,7 +47612,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -47754,7 +47675,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -47768,7 +47689,7 @@ "grant_id": { "type": "string", "description": "Grant ID made during authorization, provided to consent screen in URL search params.", - "x-example": "<GRANT_ID>" + "example": "<GRANT_ID>" } }, "required": [ @@ -47837,7 +47758,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -47851,25 +47772,25 @@ "token": { "type": "string", "description": "The access or refresh token to revoke.", - "x-example": "<TOKEN>" + "example": "<TOKEN>" }, "token_type_hint": { "type": "string", "description": "Type of token to revoke (access_token or refresh_token).", "default": "", - "x-example": "access_token" + "example": "access_token" }, "client_id": { "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "client_secret": { "type": "string", "description": "OAuth2 client secret. Required for confidential apps; omitted for public apps.", "default": "", - "x-example": "<CLIENT_SECRET>" + "example": "<CLIENT_SECRET>" } }, "required": [ @@ -47937,7 +47858,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -47951,62 +47872,61 @@ "grant_type": { "type": "string", "description": "OAuth2 grant type. Can be one of: `authorization_code`, `refresh_token`, `urn:ietf:params:oauth:grant-type:device_code`.", - "x-example": "<GRANT_TYPE>" + "example": "<GRANT_TYPE>" }, "code": { "type": "string", "description": "Authorization code to be exchanged for access and refresh tokens. Required for `authorization_code` grant type.", "default": "", - "x-example": "<CODE>" + "example": "<CODE>" }, "refresh_token": { "type": "string", "description": "Refresh token to be exchanged for a new access and refresh tokens. Required for `refresh_token` grant type.", "default": "", - "x-example": "<REFRESH_TOKEN>" + "example": "<REFRESH_TOKEN>" }, "device_code": { "type": "string", "description": "Device code obtained from the device authorization endpoint. Required for `urn:ietf:params:oauth:grant-type:device_code` grant type.", "default": "", - "x-example": "<DEVICE_CODE>" + "example": "<DEVICE_CODE>" }, "client_id": { "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "client_secret": { "type": "string", "description": "OAuth2 client secret. Required for confidential apps.", "default": "", - "x-example": "<CLIENT_SECRET>" + "example": "<CLIENT_SECRET>" }, "code_verifier": { "type": "string", "description": "PKCE code verifier. Required for public apps.", "default": "", - "x-example": "<CODE_VERIFIER>" + "example": "<CODE_VERIFIER>" }, "redirect_uri": { "type": "string", "description": "Redirect URI. Required for `authorization_code` grant type.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "<AUDIENCE>" + "example": "<AUDIENCE>" } }, "required": [ @@ -48121,7 +48041,7 @@ "name": { "type": "string", "description": "New organization name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -48243,7 +48163,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -48308,13 +48228,13 @@ "appId": { "type": "string", "description": "Application unique ID.", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" } }, "required": [ @@ -48383,7 +48303,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -48445,7 +48365,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -48459,8 +48379,8 @@ "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.", - "x-example": "<AUTHORIZATION_DETAILS>", - "x-nullable": true + "example": "<AUTHORIZATION_DETAILS>", + "nullable": true } } } @@ -48520,7 +48440,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -48594,7 +48514,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -48656,7 +48576,7 @@ "keyId": { "type": "string", "description": "Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<KEY_ID>", + "example": "<KEY_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -48664,12 +48584,11 @@ "name": { "type": "string", "description": "Key name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -48714,9 +48633,9 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -48784,7 +48703,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -48843,7 +48762,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -48857,12 +48776,11 @@ "name": { "type": "string", "description": "Key name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -48907,9 +48825,9 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -48967,7 +48885,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -49041,7 +48959,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -49052,7 +48970,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -49115,26 +49033,25 @@ "type": "string", "description": "Email of the new organization member.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "userId": { "type": "string", "description": "ID of the user to be added to the organization.", "default": "", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "roles": { "type": "array", "description": "Array of strings. Use this param to set the user roles in the organization. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", - "x-example": null, "items": { "type": "string" } @@ -49143,14 +49060,14 @@ "type": "string", "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "name": { "type": "string", "description": "Name of the new organization member. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -49216,7 +49133,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -49275,7 +49192,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -49289,7 +49206,6 @@ "roles": { "type": "array", "description": "An array of strings. Use this param to set the user's roles in the organization. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", - "x-example": null, "items": { "type": "string" } @@ -49349,7 +49265,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -49423,7 +49339,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -49434,7 +49350,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -49495,18 +49411,17 @@ "properties": { "projectId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.", - "x-example": null + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars." }, "name": { "type": "string", "description": "Project name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "region": { "type": "string", "description": "Project Region.", - "x-example": "fra", + "example": "fra", "enum": [ "fra", "nyc", @@ -49590,7 +49505,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -49649,7 +49564,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -49663,7 +49578,7 @@ "name": { "type": "string", "description": "Project name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -49720,7 +49635,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -49792,7 +49707,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -49859,7 +49774,7 @@ "organizationId": { "type": "string", "description": "Organization ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<ORGANIZATION_ID>", + "example": "<ORGANIZATION_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -49867,31 +49782,30 @@ "name": { "type": "string", "description": "Organization name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "billingPlan": { "type": "string", "description": "Organization billing plan chosen", - "x-example": "tier-0" + "example": "tier-0" }, "paymentMethodId": { "type": "string", "description": "Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.", - "x-example": "<PAYMENT_METHOD_ID>", - "x-nullable": true + "example": "<PAYMENT_METHOD_ID>", + "nullable": true }, "billingAddressId": { "type": "string", "description": "Unique ID of billing address", "default": "", - "x-example": "<BILLING_ADDRESS_ID>", - "x-nullable": true + "example": "<BILLING_ADDRESS_ID>", + "nullable": true }, "invites": { "type": "array", "description": "Additional member invites", "default": [], - "x-example": null, "items": { "type": "string" } @@ -49899,27 +49813,27 @@ "couponId": { "type": "string", "description": "Coupon id", - "x-example": "<COUPON_ID>", - "x-nullable": true + "example": "<COUPON_ID>", + "nullable": true }, "taxId": { "type": "string", "description": "Tax Id associated to billing.", - "x-example": "<TAX_ID>", - "x-nullable": true + "example": "<TAX_ID>", + "nullable": true }, "budget": { "type": "integer", "description": "Budget limit for additional usage set for the organization", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "platform": { "type": "string", "description": "Platform type", "default": "appwrite", - "x-example": "appwrite", + "example": "appwrite", "enum": [ "appwrite", "imagine" @@ -49996,19 +49910,18 @@ "billingPlan": { "type": "string", "description": "Organization billing plan chosen", - "x-example": "tier-0" + "example": "tier-0" }, "paymentMethodId": { "type": "string", "description": "Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.", - "x-example": "<PAYMENT_METHOD_ID>", - "x-nullable": true + "example": "<PAYMENT_METHOD_ID>", + "nullable": true }, "invites": { "type": "array", "description": "Additional member invites", "default": [], - "x-example": null, "items": { "type": "string" } @@ -50016,14 +49929,14 @@ "couponId": { "type": "string", "description": "Coupon id", - "x-example": "<COUPON_ID>", - "x-nullable": true + "example": "<COUPON_ID>", + "nullable": true }, "platform": { "type": "string", "description": "Platform type", "default": "appwrite", - "x-example": "appwrite", + "example": "appwrite", "enum": [ "appwrite", "imagine" @@ -50092,7 +50005,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -50151,7 +50064,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -50210,7 +50123,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -50269,7 +50182,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -50328,7 +50241,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -50338,7 +50251,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ADDON_ID>" + "example": "<ADDON_ID>" }, "in": "path" } @@ -50391,7 +50304,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -50401,7 +50314,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ADDON_ID>" + "example": "<ADDON_ID>" }, "in": "path" } @@ -50460,7 +50373,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -50470,7 +50383,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ADDON_ID>" + "example": "<ADDON_ID>" }, "in": "path" } @@ -50529,7 +50442,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -50539,7 +50452,7 @@ "required": true, "schema": { "type": "string", - "x-example": "baa", + "example": "baa", "enum": [ "baa", "premiumgeodb", @@ -50611,7 +50524,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -50683,7 +50596,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -50693,7 +50606,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<AGGREGATION_ID>" + "example": "<AGGREGATION_ID>" }, "in": "path" }, @@ -50704,7 +50617,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 5 }, "in": "query" @@ -50775,7 +50688,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -50789,7 +50702,7 @@ "billingAddressId": { "type": "string", "description": "Unique ID of billing address", - "x-example": "<BILLING_ADDRESS_ID>" + "example": "<BILLING_ADDRESS_ID>" } }, "required": [ @@ -50847,7 +50760,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -50906,7 +50819,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -50916,7 +50829,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BILLING_ADDRESS_ID>" + "example": "<BILLING_ADDRESS_ID>" }, "in": "path" } @@ -50975,7 +50888,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -50989,7 +50902,7 @@ "billingEmail": { "type": "string", "description": "Billing email for the organization.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" } }, @@ -51054,7 +50967,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -51068,9 +50981,9 @@ "budget": { "type": "integer", "description": "Budget limit for additional usage set for the organization", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "alerts": { "type": "array", @@ -51078,7 +50991,6 @@ "default": [ 75 ], - "x-example": null, "items": { "type": "integer" } @@ -51145,7 +51057,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -51215,7 +51127,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -51229,7 +51141,7 @@ "couponId": { "type": "string", "description": "ID of the coupon", - "x-example": "<COUPON_ID>" + "example": "<COUPON_ID>" } }, "required": [ @@ -51293,7 +51205,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -51352,7 +51264,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -51362,7 +51274,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<CREDIT_ID>" + "example": "<CREDIT_ID>" }, "in": "path" } @@ -51421,7 +51333,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -51480,7 +51392,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -51494,13 +51406,12 @@ "billingPlan": { "type": "string", "description": "Organization billing plan chosen", - "x-example": "tier-0" + "example": "tier-0" }, "invites": { "type": "array", "description": "Additional member invites", "default": [], - "x-example": null, "items": { "type": "string" } @@ -51508,8 +51419,8 @@ "couponId": { "type": "string", "description": "Coupon id", - "x-example": "<COUPON_ID>", - "x-nullable": true + "example": "<COUPON_ID>", + "nullable": true } }, "required": [ @@ -51573,7 +51484,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -51587,22 +51498,22 @@ "reason": { "type": "string", "description": "Feedback reason", - "x-example": "<REASON>" + "example": "<REASON>" }, "message": { "type": "string", "description": "Feedback message", - "x-example": "<MESSAGE>" + "example": "<MESSAGE>" }, "fromPlanId": { "type": "string", "description": "Plan downgrading from", - "x-example": "<FROM_PLAN_ID>" + "example": "<FROM_PLAN_ID>" }, "toPlanId": { "type": "string", "description": "Plan downgrading to", - "x-example": "<TO_PLAN_ID>" + "example": "<TO_PLAN_ID>" } }, "required": [ @@ -51669,7 +51580,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -51741,7 +51652,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -51751,7 +51662,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INVOICE_ID>" + "example": "<INVOICE_ID>" }, "in": "path" } @@ -51812,7 +51723,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -51822,7 +51733,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INVOICE_ID>" + "example": "<INVOICE_ID>" }, "in": "path" } @@ -51881,7 +51792,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -51891,7 +51802,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INVOICE_ID>" + "example": "<INVOICE_ID>" }, "in": "path" } @@ -51905,7 +51816,7 @@ "paymentMethodId": { "type": "string", "description": "Payment method ID", - "x-example": "<PAYMENT_METHOD_ID>" + "example": "<PAYMENT_METHOD_ID>" } }, "required": [ @@ -51969,7 +51880,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -51979,7 +51890,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INVOICE_ID>" + "example": "<INVOICE_ID>" }, "in": "path" } @@ -52040,7 +51951,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -52050,7 +51961,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INVOICE_ID>" + "example": "<INVOICE_ID>" }, "in": "path" } @@ -52109,7 +52020,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -52123,7 +52034,7 @@ "paymentMethodId": { "type": "string", "description": "Unique ID of payment method", - "x-example": "<PAYMENT_METHOD_ID>" + "example": "<PAYMENT_METHOD_ID>" } }, "required": [ @@ -52185,7 +52096,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -52244,7 +52155,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -52258,7 +52169,7 @@ "paymentMethodId": { "type": "string", "description": "Unique ID of payment method", - "x-example": "<PAYMENT_METHOD_ID>" + "example": "<PAYMENT_METHOD_ID>" } }, "required": [ @@ -52320,7 +52231,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -52379,7 +52290,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -52389,7 +52300,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PAYMENT_METHOD_ID>" + "example": "<PAYMENT_METHOD_ID>" }, "in": "path" } @@ -52448,7 +52359,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -52505,7 +52416,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -52519,25 +52430,24 @@ "billingPlan": { "type": "string", "description": "Organization billing plan chosen", - "x-example": "tier-0" + "example": "tier-0" }, "paymentMethodId": { "type": "string", "description": "Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.", - "x-example": "<PAYMENT_METHOD_ID>", - "x-nullable": true + "example": "<PAYMENT_METHOD_ID>", + "nullable": true }, "billingAddressId": { "type": "string", "description": "Unique ID of billing address", "default": "", - "x-example": "<BILLING_ADDRESS_ID>" + "example": "<BILLING_ADDRESS_ID>" }, "invites": { "type": "array", "description": "Additional member invites", "default": [], - "x-example": null, "items": { "type": "string" } @@ -52545,21 +52455,21 @@ "couponId": { "type": "string", "description": "Coupon id", - "x-example": "<COUPON_ID>", - "x-nullable": true + "example": "<COUPON_ID>", + "nullable": true }, "taxId": { "type": "string", "description": "Tax Id associated to billing.", - "x-example": "<TAX_ID>", - "x-nullable": true + "example": "<TAX_ID>", + "nullable": true }, "budget": { "type": "integer", "description": "Budget limit for additional usage set for the organization", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true } }, "required": [ @@ -52623,7 +52533,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -52682,7 +52592,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -52696,13 +52606,12 @@ "billingPlan": { "type": "string", "description": "Target billing plan", - "x-example": "tier-0" + "example": "tier-0" }, "invites": { "type": "array", "description": "Additional member invites", "default": [], - "x-example": null, "items": { "type": "string" } @@ -52710,8 +52619,8 @@ "couponId": { "type": "string", "description": "Coupon id", - "x-example": "<COUPON_ID>", - "x-nullable": true + "example": "<COUPON_ID>", + "nullable": true } }, "required": [ @@ -52775,7 +52684,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -52834,7 +52743,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -52844,7 +52753,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<PROJECT_ID>", + "example": "<PROJECT_ID>", "default": "" }, "in": "query" @@ -52904,7 +52813,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -52918,8 +52827,8 @@ "taxId": { "type": "string", "description": "Tax Id associated to billing.", - "x-example": "<TAX_ID>", - "x-nullable": true + "example": "<TAX_ID>", + "nullable": true } }, "required": [ @@ -52983,7 +52892,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" }, @@ -52994,7 +52903,7 @@ "schema": { "type": "string", "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "in": "query" }, @@ -53005,7 +52914,7 @@ "schema": { "type": "string", "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "in": "query" } @@ -53064,7 +52973,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ORGANIZATION_ID>" + "example": "<ORGANIZATION_ID>" }, "in": "path" } @@ -53079,7 +52988,6 @@ "type": "array", "description": "Additional member invites", "default": [], - "x-example": null, "items": { "type": "string" } @@ -53258,7 +53166,7 @@ "databaseId": { "type": "string", "description": "Database ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -53266,87 +53174,86 @@ "name": { "type": "string", "description": "Database display name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "version": { "type": "string", "description": "Database engine version. Defaults to latest for selected engine.", - "x-example": "17", - "x-nullable": true + "example": "17", + "nullable": true }, "specification": { "type": "string", "description": "Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.", "default": "s-1vcpu-1gb", - "x-example": "<SPECIFICATION>" + "example": "<SPECIFICATION>" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds.", "default": 900, - "x-example": 60, + "example": 60, "format": "int32" }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes of inactivity before container scales to zero.", "default": 15, - "x-example": 5, + "example": 5, "format": "int32" }, "pitr": { "type": "boolean", "description": "Enable point-in-time recovery (PITR). Continuously archives changes so the database can be restored to any moment within the retention window.", "default": true, - "x-example": false + "example": false }, "pitrRetentionDays": { "type": "integer", "description": "Number of days to retain PITR data.", "default": 7, - "x-example": 1, + "example": 1, "format": "int32" }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", "default": false, - "x-example": false + "example": false }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", "default": 85, - "x-example": 50, + "example": 50, "format": "int32" }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -53461,7 +53368,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -53519,7 +53426,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -53533,139 +53440,136 @@ "name": { "type": "string", "description": "Database display name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "status": { "type": "string", "description": "Database status. Allowed values: ready, paused, inactive. Set to \"paused\" to pause, \"ready\" to resume (also recovers a failed database whose infrastructure is healthy), or \"inactive\" to spin down a shared-pool database.", - "x-example": "ready", - "x-nullable": true + "example": "ready", + "nullable": true }, "specification": { "type": "string", "description": "Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds (60-86400).", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes before container scales to zero.", - "x-example": 5, + "example": 5, "format": "int32", - "x-nullable": true + "nullable": true }, "pitr": { "type": "boolean", "description": "Enable or disable point-in-time recovery (PITR).", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "pitrRetentionDays": { "type": "integer", "description": "Days to retain PITR data.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", - "x-example": 50, + "example": 50, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "metricsTraceSampleRate": { "type": "number", "description": "Fraction of queries to trace (0.0\u20131.0). Forwarded to the sidecar.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "metricsSlowQueryLogThresholdMs": { "type": "integer", "description": "Threshold in ms above which queries are logged as slow. Forwarded to the sidecar.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiEnabled": { "type": "boolean", "description": "Enable the SQL API sidecar for this database.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "sqlApiAllowedStatements": { "type": "array", "description": "Statement types the SQL API accepts. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "sqlApiMaxRows": { "type": "integer", "description": "Maximum rows returned per SQL API execution (1-1000000).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiMaxBytes": { "type": "integer", "description": "Maximum serialised SQL API result payload in bytes (1024-104857600).", - "x-example": 1024, + "example": 1024, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiTimeoutSeconds": { "type": "integer", "description": "Per-call SQL API execution timeout in seconds (1-300).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } } } @@ -53721,7 +53625,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -53781,7 +53685,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -53852,7 +53756,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -53867,7 +53771,7 @@ "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" } } } @@ -53929,7 +53833,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -54000,7 +53904,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -54014,7 +53918,7 @@ "policyId": { "type": "string", "description": "Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<POLICY_ID>", + "example": "<POLICY_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -54022,30 +53926,29 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32" }, "type": { "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -54113,7 +54016,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -54123,7 +54026,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -54181,7 +54084,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -54191,7 +54094,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -54205,26 +54108,25 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -54280,7 +54182,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -54290,7 +54192,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -54350,7 +54252,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -54364,40 +54266,40 @@ "provider": { "type": "string", "description": "Storage provider for off-cluster backups. Allowed values: s3 (Amazon S3 or S3-compatible), gcs (Google Cloud Storage), azure (Azure Blob Storage).", - "x-example": "s3" + "example": "s3" }, "bucket": { "type": "string", "description": "Storage bucket or container name.", - "x-example": "<BUCKET>" + "example": "<BUCKET>" }, "region": { "type": "string", "description": "Storage region.", "default": "", - "x-example": "<REGION>" + "example": "<REGION>" }, "prefix": { "type": "string", "description": "Object key prefix for backups.", "default": "backups\/", - "x-example": "<PREFIX>" + "example": "<PREFIX>" }, "endpoint": { "type": "string", "description": "Custom endpoint for S3-compatible storage (e.g. MinIO).", "default": "", - "x-example": "<ENDPOINT>" + "example": "<ENDPOINT>" }, "accessKey": { "type": "string", "description": "Access key or client ID for authentication.", - "x-example": "<ACCESS_KEY>" + "example": "<ACCESS_KEY>" }, "secretKey": { "type": "string", "description": "Secret key or service account JSON for authentication.", - "x-example": "<SECRET_KEY>" + "example": "<SECRET_KEY>" } }, "required": [ @@ -54465,7 +54367,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -54475,7 +54377,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -54529,7 +54431,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -54539,7 +54441,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -54599,7 +54501,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -54657,7 +54559,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -54672,7 +54574,7 @@ "type": "string", "description": "Branch ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": "", - "x-example": "<BRANCH_ID>", + "example": "<BRANCH_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -54681,7 +54583,7 @@ "type": "integer", "description": "Time-to-live in seconds before the branch expires. Min 300 (5 min), max 604800 (7 days). Default: 86400 (24h).", "default": 86400, - "x-example": 300, + "example": 300, "format": "int32" } } @@ -54744,7 +54646,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -54754,7 +54656,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BRANCH_ID>" + "example": "<BRANCH_ID>" }, "in": "path" } @@ -54814,7 +54716,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -54874,7 +54776,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -54888,21 +54790,21 @@ "sql": { "type": "string", "description": "SQL statement to execute. Exactly one statement per request.", - "x-example": "<SQL>" + "example": "<SQL>" }, "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 + "example": {}, + "nullable": true }, "timeoutSeconds": { "type": "integer", "description": "Per-call execution timeout override. Must be less than or equal to the database's configured sqlApiTimeoutSeconds.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } }, "required": [ @@ -54967,7 +54869,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -55025,7 +54927,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -55039,7 +54941,7 @@ "name": { "type": "string", "description": "Extension name (e.g., pgvector, postgis, uuid-ossp).", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -55104,7 +55006,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -55114,7 +55016,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<EXTENSION_NAME>" + "example": "<EXTENSION_NAME>" }, "in": "path" } @@ -55174,7 +55076,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -55188,8 +55090,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -55251,7 +55153,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -55265,12 +55167,12 @@ "day": { "type": "string", "description": "Day of the week for the maintenance window. Allowed values: sun, mon, tue, wed, thu, fri, sat.", - "x-example": "sun" + "example": "sun" }, "hourUtc": { "type": "integer", "description": "Hour in UTC (0-23) for maintenance window start.", - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -55337,7 +55239,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -55351,13 +55253,13 @@ "targetType": { "type": "string", "description": "Target database type to migrate to. Allowed values: shared (serverless, scales to zero when idle), dedicated (always-on with persistent resources).", - "x-example": "shared" + "example": "shared" }, "specification": { "type": "string", "description": "Target specification to provision when migrating to dedicated. Ignored for shared. Defaults to the database's current specification.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true } }, "required": [ @@ -55422,7 +55324,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -55432,7 +55334,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -55443,7 +55345,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -55455,7 +55357,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -55516,7 +55418,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -55576,7 +55478,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -55634,7 +55536,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -55648,52 +55550,52 @@ "mode": { "type": "string", "description": "Connection pool mode. Allowed values: transaction, session. Transaction mode returns connections to the pool after each transaction; session mode holds connections for the entire session lifetime.", - "x-example": "transaction", - "x-nullable": true + "example": "transaction", + "nullable": true }, "maxConnections": { "type": "integer", "description": "Client-connection ceiling the pooler accepts. Supported on MySQL and MariaDB only; the PostgreSQL pooler has no client cap, so set networkMaxConnections on the database instead.", - "x-example": 10, + "example": 10, "format": "int32", - "x-nullable": true + "nullable": true }, "defaultPoolSize": { "type": "integer", "description": "Default pool size per user.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "readWriteSplitting": { "type": "boolean", "description": "Route SELECTs to HA replicas, writes and locked reads to the primary. Defaults to true when HA is enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "poolerCpuRequest": { "type": "string", "description": "Pooler sidecar CPU request override (Kubernetes quantity, e.g. \"250m\" or \"1\"). Leave null for the proportional default (5% of DB CPU, floor 100m).", - "x-example": "<POOLER_CPU_REQUEST>", - "x-nullable": true + "example": "<POOLER_CPU_REQUEST>", + "nullable": true }, "poolerCpuLimit": { "type": "string", "description": "Pooler sidecar CPU limit override (Kubernetes quantity, e.g. \"500m\" or \"1\"). Leave null for the proportional default (10% of DB CPU, floor 200m). Changing this field rolls the database pod.", - "x-example": "<POOLER_CPU_LIMIT>", - "x-nullable": true + "example": "<POOLER_CPU_LIMIT>", + "nullable": true }, "poolerMemoryRequest": { "type": "string", "description": "Pooler sidecar memory request override (Kubernetes quantity, e.g. \"128Mi\" or \"1Gi\"). Leave null for the proportional default (7.5% of DB memory, floor 64Mi).", - "x-example": "<POOLER_MEMORY_REQUEST>", - "x-nullable": true + "example": "<POOLER_MEMORY_REQUEST>", + "nullable": true }, "poolerMemoryLimit": { "type": "string", "description": "Pooler sidecar memory limit override (Kubernetes quantity, e.g. \"256Mi\" or \"1Gi\"). Leave null for the proportional default (15% of DB memory, floor 128Mi). Changing this field rolls the database pod.", - "x-example": "<POOLER_MEMORY_LIMIT>", - "x-nullable": true + "example": "<POOLER_MEMORY_LIMIT>", + "nullable": true } } } @@ -55755,7 +55657,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -55815,7 +55717,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -55825,7 +55727,7 @@ "required": false, "schema": { "type": "string", - "x-example": "pending" + "example": "pending" }, "in": "query" }, @@ -55835,7 +55737,7 @@ "required": false, "schema": { "type": "string", - "x-example": "backup" + "example": "backup" }, "in": "query" }, @@ -55846,7 +55748,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -55858,7 +55760,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -55917,7 +55819,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -55932,26 +55834,26 @@ "type": "string", "description": "Restoration type. Allowed values: backup, pitr. Use \"backup\" to restore from a specific backup, or \"pitr\" for point-in-time recovery.", "default": "backup", - "x-example": "backup" + "example": "backup" }, "backupId": { "type": "string", "description": "Backup ID to restore from (required for backup type).", - "x-example": "<BACKUP_ID>", - "x-nullable": true + "example": "<BACKUP_ID>", + "nullable": true }, "targetDatabaseId": { "type": "string", "description": "Existing database ID to restore into. The target must be distinct, ready, and use the same engine and version.", - "x-example": "<TARGET_DATABASE_ID>", - "x-nullable": true + "example": "<TARGET_DATABASE_ID>", + "nullable": true }, "targetTime": { "type": "string", "description": "Target time for PITR (required for pitr type) as an [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -56013,7 +55915,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -56023,7 +55925,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RESTORATION_ID>" + "example": "<RESTORATION_ID>" }, "in": "path" } @@ -56083,7 +55985,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -56143,7 +56045,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -56157,7 +56059,7 @@ "targetVersion": { "type": "string", "description": "Target engine version to upgrade to.", - "x-example": "<TARGET_VERSION>" + "example": "<TARGET_VERSION>" } }, "required": [ @@ -56239,7 +56141,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -56251,7 +56153,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -56311,7 +56213,7 @@ "required": false, "schema": { "type": "string", - "x-example": "24h", + "example": "24h", "enum": [ "24h", "30d", @@ -56387,7 +56289,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PRESENCE_ID>" + "example": "<PRESENCE_ID>" }, "in": "path" } @@ -56476,7 +56378,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PRESENCE_ID>" + "example": "<PRESENCE_ID>" }, "in": "path" } @@ -56490,17 +56392,19 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "status": { "type": "string", "description": "Presence status.", - "x-example": "<STATUS>" + "example": "<STATUS>" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -56508,14 +56412,14 @@ "expiresAt": { "type": "string", "description": "Presence expiry datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime" }, "metadata": { "type": "object", "description": "Presence metadata object.", "default": [], - "x-example": "{}" + "example": {} } }, "required": [ @@ -56609,7 +56513,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PRESENCE_ID>" + "example": "<PRESENCE_ID>" }, "in": "path" } @@ -56623,29 +56527,31 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "status": { "type": "string", "description": "Presence status.", - "x-example": "<STATUS>" + "example": "<STATUS>" }, "expiresAt": { "type": "string", "description": "Presence expiry datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime" }, "metadata": { "type": "object", "description": "Presence metadata object.", "default": {}, - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -56654,7 +56560,7 @@ "type": "boolean", "description": "When true, purge cached responses used by list presences endpoint.", "default": false, - "x-example": false + "example": false } } } @@ -56711,7 +56617,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PRESENCE_ID>" + "example": "<PRESENCE_ID>" }, "in": "path" } @@ -56858,7 +56764,7 @@ "required": true, "schema": { "type": "string", - "x-example": "email-password", + "example": "email-password", "enum": [ "email-password", "magic-url", @@ -56891,7 +56797,7 @@ "enabled": { "type": "boolean", "description": "Auth method status.", - "x-example": false + "example": false } }, "required": [ @@ -56969,7 +56875,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -57028,7 +56934,7 @@ "keyId": { "type": "string", "description": "Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<KEY_ID>", + "example": "<KEY_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -57036,12 +56942,11 @@ "name": { "type": "string", "description": "Key name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -57264,9 +57169,9 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -57335,7 +57240,6 @@ "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -57558,7 +57462,7 @@ "duration": { "type": "integer", "description": "Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.", - "x-example": "600", + "example": 600, "format": "int32" } }, @@ -57625,7 +57529,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -57683,7 +57587,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -57697,12 +57601,11 @@ "name": { "type": "string", "description": "Key name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -57925,9 +57828,9 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -57984,7 +57887,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -58046,7 +57949,6 @@ "labels": { "type": "array", "description": "Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", - "x-example": null, "items": { "type": "string" } @@ -58127,7 +58029,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -58188,13 +58090,13 @@ "number": { "type": "string", "description": "Phone number to associate with the mock phone. Must be a valid E.164 formatted phone number.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "otp": { "type": "string", "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", - "x-example": "<OTP>" + "example": "<OTP>" } }, "required": [ @@ -58261,7 +58163,7 @@ "schema": { "type": "string", "format": "phone", - "x-example": "+12065550100" + "example": "+12065550100" }, "in": "path" } @@ -58320,7 +58222,7 @@ "schema": { "type": "string", "format": "phone", - "x-example": "+12065550100" + "example": "+12065550100" }, "in": "path" } @@ -58334,7 +58236,7 @@ "otp": { "type": "string", "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", - "x-example": "<OTP>" + "example": "<OTP>" } }, "required": [ @@ -58391,7 +58293,7 @@ "schema": { "type": "string", "format": "phone", - "x-example": "+12065550100" + "example": "+12065550100" }, "in": "path" } @@ -58464,7 +58366,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -58527,19 +58429,18 @@ "enabled": { "type": "boolean", "description": "Enable or disable the OAuth2 server.", - "x-example": false + "example": false }, "authorizationUrl": { "type": "string", "description": "URL to your application with consent screen.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "scopes": { "type": "array", "description": "List of allowed OAuth2 scopes. Maximum of 100 scopes are allowed, each up to 128 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -58548,7 +58449,6 @@ "type": "array", "description": "List of accepted `authorization_details` types. Maximum of 100 types are allowed, each up to 128 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -58556,76 +58456,75 @@ "accessTokenDuration": { "type": "integer", "description": "Access token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 8 hours.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "refreshTokenDuration": { "type": "integer", "description": "Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "publicAccessTokenDuration": { "type": "integer", "description": "Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "publicRefreshTokenDuration": { "type": "integer", "description": "Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "installationAccessTokenDuration": { "type": "integer", "description": "Access token duration in seconds for app installation access tokens. Leave empty to use default 1 hour.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "confidentialPkce": { "type": "boolean", "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "verificationUrl": { "type": "string", "description": "URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "userCodeLength": { "type": "integer", "description": "Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.", - "x-example": 6, + "example": 6, "format": "int32", - "x-nullable": true + "nullable": true }, "userCodeFormat": { "type": "string", "description": "Character set for device flow user codes: `numeric` (digits only \u2014 best for numeric keypads and TV remotes), `alphabetic` (letters only), or `alphanumeric` (letters and digits \u2014 highest entropy per character). Defaults to `alphanumeric`.", "default": "alphanumeric", - "x-example": "numeric" + "example": "numeric" }, "deviceCodeDuration": { "type": "integer", "description": "Lifetime in seconds of device flow device codes and user codes. Device codes are intentionally short-lived. Leave empty to use default 600.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "defaultScopes": { "type": "array", "description": "List of OAuth2 scopes used when an authorization request omits the scope parameter. Every default scope must also be allowed by the OAuth2 server. Maximum of 100 scopes are allowed, each up to 128 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -58634,7 +58533,6 @@ "type": "array", "description": "List of scopes an application may request when installed on a team. Omitting the parameter clears the list, so no installation scopes can be granted. Maximum of 100 scopes are allowed, each up to 128 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -58705,20 +58603,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -58782,32 +58680,32 @@ "serviceId": { "type": "string", "description": "'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web", - "x-example": "<SERVICE_ID>", - "x-nullable": true + "example": "<SERVICE_ID>", + "nullable": true }, "keyId": { "type": "string", "description": "'Key ID' of Apple OAuth2 app. For example: P4000000N8", - "x-example": "<KEY_ID>", - "x-nullable": true + "example": "<KEY_ID>", + "nullable": true }, "teamId": { "type": "string", "description": "'Team ID' of Apple OAuth2 app. For example: D4000000R6", - "x-example": "<TEAM_ID>", - "x-nullable": true + "example": "<TEAM_ID>", + "nullable": true }, "p8File": { "type": "string", "description": "Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----", - "x-example": "<P8_FILE>", - "x-nullable": true + "example": "<P8_FILE>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -58871,20 +58769,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Appwrite OAuth2 app. For example: 6a42000000000000b5a0", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Appwrite OAuth2 app. For example: b86afd000000000000000000000000000000000000000000000000000ced5f93", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -58948,26 +58846,26 @@ "clientId": { "type": "string", "description": "'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "endpoint": { "type": "string", "description": "Domain of Auth0 instance. For example: example.us.auth0.com", - "x-example": "<ENDPOINT>", - "x-nullable": true + "example": "<ENDPOINT>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59031,26 +58929,26 @@ "clientId": { "type": "string", "description": "'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "endpoint": { "type": "string", "description": "Domain of Authentik instance. For example: example.authentik.com", - "x-example": "<ENDPOINT>", - "x-nullable": true + "example": "<ENDPOINT>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59114,20 +59012,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59191,20 +59089,20 @@ "key": { "type": "string", "description": "'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc", - "x-example": "<KEY>", - "x-nullable": true + "example": "<KEY>", + "nullable": true }, "secret": { "type": "string", "description": "'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx", - "x-example": "<SECRET>", - "x-nullable": true + "example": "<SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59268,20 +59166,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59345,20 +59243,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59422,20 +59320,20 @@ "apiKey": { "type": "string", "description": "'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f", - "x-example": "<API_KEY>", - "x-nullable": true + "example": "<API_KEY>", + "nullable": true }, "apiSecret": { "type": "string", "description": "'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639", - "x-example": "<API_SECRET>", - "x-nullable": true + "example": "<API_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59499,20 +59397,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Discord OAuth2 app. For example: 950722000000343754", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59576,20 +59474,20 @@ "publicKey": { "type": "string", "description": "'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", - "x-example": "<PUBLIC_KEY>", - "x-nullable": true + "example": "<PUBLIC_KEY>", + "nullable": true }, "secretKey": { "type": "string", "description": "'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9", - "x-example": "<SECRET_KEY>", - "x-nullable": true + "example": "<SECRET_KEY>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59653,20 +59551,20 @@ "appKey": { "type": "string", "description": "'App Key' of Dropbox OAuth2 app. For example: jl000000000009t", - "x-example": "<APP_KEY>", - "x-nullable": true + "example": "<APP_KEY>", + "nullable": true }, "appSecret": { "type": "string", "description": "'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw", - "x-example": "<APP_SECRET>", - "x-nullable": true + "example": "<APP_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59730,20 +59628,20 @@ "keyString": { "type": "string", "description": "'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2", - "x-example": "<KEY_STRING>", - "x-nullable": true + "example": "<KEY_STRING>", + "nullable": true }, "sharedSecret": { "type": "string", "description": "'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru", - "x-example": "<SHARED_SECRET>", - "x-nullable": true + "example": "<SHARED_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59807,20 +59705,20 @@ "appId": { "type": "string", "description": "'App ID' of Facebook OAuth2 app. For example: 260600000007694", - "x-example": "<APP_ID>", - "x-nullable": true + "example": "<APP_ID>", + "nullable": true }, "appSecret": { "type": "string", "description": "'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4", - "x-example": "<APP_SECRET>", - "x-nullable": true + "example": "<APP_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59884,20 +59782,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -59961,26 +59859,26 @@ "clientId": { "type": "string", "description": "'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "endpoint": { "type": "string", "description": "Domain of FusionAuth instance. For example: example.fusionauth.io", - "x-example": "<ENDPOINT>", - "x-nullable": true + "example": "<ENDPOINT>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60044,20 +59942,20 @@ "clientId": { "type": "string", "description": "'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60121,27 +60019,27 @@ "applicationId": { "type": "string", "description": "'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252", - "x-example": "<APPLICATION_ID>", - "x-nullable": true + "example": "<APPLICATION_ID>", + "nullable": true }, "secret": { "type": "string", "description": "'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", - "x-example": "<SECRET>", - "x-nullable": true + "example": "<SECRET>", + "nullable": true }, "endpoint": { "type": "string", "description": "Endpoint URL of self-hosted GitLab instance. For example: https:\/\/gitlab.com", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60205,19 +60103,18 @@ "clientId": { "type": "string", "description": "'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "prompt": { "type": "array", "description": "Array of Google OAuth2 prompt values. If \"none\" is included, it must be the only element. \"none\" means: don't display any authentication or consent screens. Must not be specified with other values. \"consent\" means: prompt the user for consent. \"select_account\" means: prompt the user to select an account.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -60232,13 +60129,13 @@ "select_account" ] }, - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60302,32 +60199,32 @@ "clientId": { "type": "string", "description": "'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "endpoint": { "type": "string", "description": "Domain of Keycloak instance. For example: keycloak.example.com", - "x-example": "<ENDPOINT>", - "x-nullable": true + "example": "<ENDPOINT>", + "nullable": true }, "realmName": { "type": "string", "description": "Keycloak realm name. For example: appwrite-realm", - "x-example": "<REALM_NAME>", - "x-nullable": true + "example": "<REALM_NAME>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60391,20 +60288,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60468,20 +60365,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "primaryClientSecret": { "type": "string", "description": "'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000.\/HtlYw==", - "x-example": "<PRIMARY_CLIENT_SECRET>", - "x-nullable": true + "example": "<PRIMARY_CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60545,26 +60442,26 @@ "applicationId": { "type": "string", "description": "'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444", - "x-example": "<APPLICATION_ID>", - "x-nullable": true + "example": "<APPLICATION_ID>", + "nullable": true }, "applicationSecret": { "type": "string", "description": "'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", - "x-example": "<APPLICATION_SECRET>", - "x-nullable": true + "example": "<APPLICATION_SECRET>", + "nullable": true }, "tenant": { "type": "string", "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common", - "x-example": "<TENANT>", - "x-nullable": true + "example": "<TENANT>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60628,20 +60525,20 @@ "oauthClientId": { "type": "string", "description": "'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3", - "x-example": "<OAUTH_CLIENT_ID>", - "x-nullable": true + "example": "<OAUTH_CLIENT_ID>", + "nullable": true }, "oauthClientSecret": { "type": "string", "description": "'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9", - "x-example": "<OAUTH_CLIENT_SECRET>", - "x-nullable": true + "example": "<OAUTH_CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60705,47 +60602,46 @@ "clientId": { "type": "string", "description": "'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "wellKnownURL": { "type": "string", "description": "OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https:\/\/myoauth.com\/.well-known\/openid-configuration", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "authorizationURL": { "type": "string", "description": "OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/authorize", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/token", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/userinfo", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "prompt": { "type": "array", "description": "Array of OpenID Connect prompt values controlling the authentication and consent screens. If \"none\" is included, it must be the only element. \"none\" means: don't display any authentication or consent screens. \"login\" means: prompt the user to re-authenticate. \"consent\" means: prompt the user for consent. \"select_account\" means: prompt the user to select an account.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -60762,20 +60658,20 @@ "select_account" ] }, - "x-nullable": true + "nullable": true }, "maxAge": { "type": "integer", "description": "Maximum authentication age in seconds. When set, the user must have authenticated within this many seconds, otherwise they are prompted to re-authenticate.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60839,32 +60735,31 @@ "clientId": { "type": "string", "description": "'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "domain": { "type": "string", "description": "Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https:\/\/trial-6400025.okta.com\/", - "x-example": null, - "x-nullable": true + "nullable": true }, "authorizationServerId": { "type": "string", "description": "Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z", - "x-example": "<AUTHORIZATION_SERVER_ID>", - "x-nullable": true + "example": "<AUTHORIZATION_SERVER_ID>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -60928,20 +60823,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "secretKey": { "type": "string", "description": "'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", - "x-example": "<SECRET_KEY>", - "x-nullable": true + "example": "<SECRET_KEY>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61005,20 +60900,20 @@ "clientId": { "type": "string", "description": "'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "secretKey": { "type": "string", "description": "'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", - "x-example": "<SECRET_KEY>", - "x-nullable": true + "example": "<SECRET_KEY>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61082,20 +60977,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61159,20 +61054,20 @@ "customerKey": { "type": "string", "description": "'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", - "x-example": "<CUSTOMER_KEY>", - "x-nullable": true + "example": "<CUSTOMER_KEY>", + "nullable": true }, "customerSecret": { "type": "string", "description": "'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2", - "x-example": "<CUSTOMER_SECRET>", - "x-nullable": true + "example": "<CUSTOMER_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61236,20 +61131,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61313,20 +61208,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61390,20 +61285,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "apiSecretKey": { "type": "string", "description": "'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp", - "x-example": "<API_SECRET_KEY>", - "x-nullable": true + "example": "<API_SECRET_KEY>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61467,20 +61362,20 @@ "oauth2ClientId": { "type": "string", "description": "'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app", - "x-example": "<OAUTH2_CLIENT_ID>", - "x-nullable": true + "example": "<OAUTH2_CLIENT_ID>", + "nullable": true }, "oauth2ClientSecret": { "type": "string", "description": "'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", - "x-example": "<OAUTH2_CLIENT_SECRET>", - "x-nullable": true + "example": "<OAUTH2_CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61544,20 +61439,20 @@ "oauth2ClientId": { "type": "string", "description": "'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app", - "x-example": "<OAUTH2_CLIENT_ID>", - "x-nullable": true + "example": "<OAUTH2_CLIENT_ID>", + "nullable": true }, "oauth2ClientSecret": { "type": "string", "description": "'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", - "x-example": "<OAUTH2_CLIENT_SECRET>", - "x-nullable": true + "example": "<OAUTH2_CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61621,20 +61516,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61698,20 +61593,20 @@ "clientId": { "type": "string", "description": "'Client ID' of WordPress OAuth2 app. For example: 130005", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61775,20 +61670,20 @@ "customerKey": { "type": "string", "description": "'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT", - "x-example": "<CUSTOMER_KEY>", - "x-nullable": true + "example": "<CUSTOMER_KEY>", + "nullable": true }, "secretKey": { "type": "string", "description": "'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9", - "x-example": "<SECRET_KEY>", - "x-nullable": true + "example": "<SECRET_KEY>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61852,20 +61747,20 @@ "clientId": { "type": "string", "description": "'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -61929,20 +61824,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -62006,20 +61901,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -62083,20 +61978,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -62326,7 +62221,7 @@ "required": true, "schema": { "type": "string", - "x-example": "amazon", + "example": "amazon", "enum": [ "amazon", "apple", @@ -62492,7 +62387,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -62555,7 +62450,7 @@ "platformId": { "type": "string", "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PLATFORM_ID>", + "example": "<PLATFORM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -62563,12 +62458,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "applicationId": { "type": "string", "description": "Android application ID. Max length: 256 chars.", - "x-example": "<APPLICATION_ID>" + "example": "<APPLICATION_ID>" } }, "required": [ @@ -62635,7 +62530,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -62649,12 +62544,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "applicationId": { "type": "string", "description": "Android application ID. Max length: 256 chars.", - "x-example": "<APPLICATION_ID>" + "example": "<APPLICATION_ID>" } }, "required": [ @@ -62722,7 +62617,7 @@ "platformId": { "type": "string", "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PLATFORM_ID>", + "example": "<PLATFORM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -62730,12 +62625,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "bundleIdentifier": { "type": "string", "description": "Apple bundle identifier. Max length: 256 chars.", - "x-example": "<BUNDLE_IDENTIFIER>" + "example": "<BUNDLE_IDENTIFIER>" } }, "required": [ @@ -62802,7 +62697,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -62816,12 +62711,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "bundleIdentifier": { "type": "string", "description": "Apple bundle identifier. Max length: 256 chars.", - "x-example": "<BUNDLE_IDENTIFIER>" + "example": "<BUNDLE_IDENTIFIER>" } }, "required": [ @@ -62889,7 +62784,7 @@ "platformId": { "type": "string", "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PLATFORM_ID>", + "example": "<PLATFORM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -62897,12 +62792,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "packageName": { "type": "string", "description": "Linux package name. Max length: 256 chars.", - "x-example": "<PACKAGE_NAME>" + "example": "<PACKAGE_NAME>" } }, "required": [ @@ -62969,7 +62864,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -62983,12 +62878,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "packageName": { "type": "string", "description": "Linux package name. Max length: 256 chars.", - "x-example": "<PACKAGE_NAME>" + "example": "<PACKAGE_NAME>" } }, "required": [ @@ -63056,7 +62951,7 @@ "platformId": { "type": "string", "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PLATFORM_ID>", + "example": "<PLATFORM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -63064,12 +62959,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "hostname": { "type": "string", "description": "Platform web hostname. Max length: 256 chars.", - "x-example": "app.example.com" + "example": "app.example.com" } }, "required": [ @@ -63136,7 +63031,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -63150,12 +63045,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "hostname": { "type": "string", "description": "Platform web hostname. Max length: 256 chars.", - "x-example": "app.example.com" + "example": "app.example.com" } }, "required": [ @@ -63223,7 +63118,7 @@ "platformId": { "type": "string", "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PLATFORM_ID>", + "example": "<PLATFORM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -63231,12 +63126,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "packageIdentifierName": { "type": "string", "description": "Windows package identifier name. Max length: 256 chars.", - "x-example": "<PACKAGE_IDENTIFIER_NAME>" + "example": "<PACKAGE_IDENTIFIER_NAME>" } }, "required": [ @@ -63303,7 +63198,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -63317,12 +63212,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "packageIdentifierName": { "type": "string", "description": "Windows package identifier name. Max length: 256 chars.", - "x-example": "<PACKAGE_IDENTIFIER_NAME>" + "example": "<PACKAGE_IDENTIFIER_NAME>" } }, "required": [ @@ -63414,7 +63309,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -63465,7 +63360,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -63541,7 +63436,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -63607,7 +63502,7 @@ "enabled": { "type": "boolean", "description": "Set whether or not to block aliased emails during signup and email updates.", - "x-example": false + "example": false } }, "required": [ @@ -63677,7 +63572,7 @@ "enabled": { "type": "boolean", "description": "Set whether or not to restrict sign-ups and email updates to corporate email addresses only.", - "x-example": false + "example": false } }, "required": [ @@ -63747,7 +63642,7 @@ "enabled": { "type": "boolean", "description": "Set whether or not to block disposable email addresses during signup and email updates.", - "x-example": false + "example": false } }, "required": [ @@ -63817,7 +63712,7 @@ "enabled": { "type": "boolean", "description": "Set whether or not to block free email addresses during signup and email updates.", - "x-example": false + "example": false } }, "required": [ @@ -63887,32 +63782,32 @@ "userId": { "type": "boolean", "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", - "x-example": false + "example": false }, "userEmail": { "type": "boolean", "description": "Set to true if you want make user email visible to all team members, or false to hide it.", - "x-example": false + "example": false }, "userPhone": { "type": "boolean", "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", - "x-example": false + "example": false }, "userName": { "type": "boolean", "description": "Set to true if you want make user name visible to all team members, or false to hide it.", - "x-example": false + "example": false }, "userMFA": { "type": "boolean", "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", - "x-example": false + "example": false }, "userAccessedAt": { "type": "boolean", "description": "Set to true if you want make user last access time visible to all team members, or false to hide it.", - "x-example": false + "example": false } } } @@ -63979,22 +63874,22 @@ "totp": { "type": "boolean", "description": "Set to true to allow TOTP to complete an MFA challenge, or false to disable it.", - "x-example": false + "example": false }, "email": { "type": "boolean", "description": "Set to true to allow email to complete an MFA challenge, or false to disable it.", - "x-example": false + "example": false }, "phone": { "type": "boolean", "description": "Set to true to allow phone (SMS) to complete an MFA challenge, or false to disable it.", - "x-example": false + "example": false }, "custom": { "type": "boolean", "description": "Set to true to allow the custom factor to complete an MFA challenge, or false to disable it.", - "x-example": false + "example": false } } } @@ -64061,7 +63956,7 @@ "enabled": { "type": "boolean", "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", - "x-example": false + "example": false } }, "required": [ @@ -64131,9 +64026,9 @@ "total": { "type": "integer", "description": "Set the password history length per user. Value can be between 1 and 20, or null to disable the limit.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } }, "required": [ @@ -64203,7 +64098,7 @@ "enabled": { "type": "boolean", "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", - "x-example": false + "example": false } }, "required": [ @@ -64273,28 +64168,28 @@ "min": { "type": "integer", "description": "Minimum password length. Value must be between 8 and 256. Default is 8.", - "x-example": 8, + "example": 8, "format": "int32" }, "uppercase": { "type": "boolean", "description": "Whether passwords must include at least one uppercase letter.", - "x-example": false + "example": false }, "lowercase": { "type": "boolean", "description": "Whether passwords must include at least one lowercase letter.", - "x-example": false + "example": false }, "number": { "type": "boolean", "description": "Whether passwords must include at least one number.", - "x-example": false + "example": false }, "symbols": { "type": "boolean", "description": "Whether passwords must include at least one symbol.", - "x-example": false + "example": false } } } @@ -64361,7 +64256,7 @@ "enabled": { "type": "boolean", "description": "Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.", - "x-example": false + "example": false } }, "required": [ @@ -64431,7 +64326,7 @@ "duration": { "type": "integer", "description": "Maximum session length in seconds. Minium allowed value is 60 seconds, and maximum is 1 year, which is 31536000 seconds.", - "x-example": 60, + "example": 60, "format": "int32" } }, @@ -64502,7 +64397,7 @@ "enabled": { "type": "boolean", "description": "Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.", - "x-example": false + "example": false } }, "required": [ @@ -64572,7 +64467,7 @@ "total": { "type": "integer", "description": "Set the maximum number of sessions allowed per user. Value can be between 1 and 100.", - "x-example": 1, + "example": 1, "format": "int32" } }, @@ -64643,9 +64538,9 @@ "total": { "type": "integer", "description": "Set the maximum number of users allowed in the project. Value can be between 0 and 10000. Use 0 or null to disable the limit.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true } }, "required": [ @@ -64779,7 +64674,7 @@ "required": true, "schema": { "type": "string", - "x-example": "password-dictionary", + "example": "password-dictionary", "enum": [ "password-dictionary", "password-history", @@ -64874,7 +64769,7 @@ "required": true, "schema": { "type": "string", - "x-example": "rest", + "example": "rest", "enum": [ "rest", "graphql", @@ -64899,7 +64794,7 @@ "enabled": { "type": "boolean", "description": "Protocol status.", - "x-example": false + "example": false } }, "required": [ @@ -64964,7 +64859,7 @@ "required": true, "schema": { "type": "string", - "x-example": "account", + "example": "account", "enum": [ "account", "avatars", @@ -65021,7 +64916,7 @@ "enabled": { "type": "boolean", "description": "Service status.", - "x-example": false + "example": false } }, "required": [ @@ -65088,59 +64983,57 @@ "host": { "type": "string", "description": "SMTP server hostname (domain)", - "x-example": null, - "x-nullable": true + "nullable": true }, "port": { "type": "integer", "description": "SMTP server port", - "x-example": null, "format": "int32", - "x-nullable": true + "nullable": true }, "username": { "type": "string", "description": "SMTP server username. Pass an empty string to clear a previously set value.", - "x-example": "<USERNAME>", - "x-nullable": true + "example": "<USERNAME>", + "nullable": true }, "password": { "type": "string", "description": "SMTP server password. Pass an empty string to clear a previously set value. This property is stored securely and cannot be read in future (write-only).", - "x-example": "password", + "example": "password", "format": "password", - "x-nullable": true + "nullable": true }, "senderEmail": { "type": "string", "description": "Email address shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "senderName": { "type": "string", "description": "Name shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.", - "x-example": "<SENDER_NAME>", - "x-nullable": true + "example": "<SENDER_NAME>", + "nullable": true }, "replyToEmail": { "type": "string", "description": "Email used when user replies to the email. Pass an empty string to clear a previously set value.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "replyToName": { "type": "string", "description": "Name used when user replies to the email. Pass an empty string to clear a previously set value.", - "x-example": "<REPLY_TO_NAME>", - "x-nullable": true + "example": "<REPLY_TO_NAME>", + "nullable": true }, "secure": { "type": "string", "description": "Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.", - "x-example": "tls", + "example": "tls", "enum": [ "tls", "ssl" @@ -65150,13 +65043,13 @@ "tls", "ssl" ], - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -65213,7 +65106,6 @@ "emails": { "type": "array", "description": "Array of emails to send test email to. Maximum of 10 emails are allowed.", - "x-example": null, "items": { "type": "string" } @@ -65294,7 +65186,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -65355,7 +65247,7 @@ "templateId": { "type": "string", "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", - "x-example": "verification", + "example": "verification", "enum": [ "verification", "magicSession", @@ -65379,7 +65271,7 @@ "locale": { "type": "string", "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", - "x-example": "af", + "example": "af", "enum": [ "af", "ar-ae", @@ -65651,40 +65543,40 @@ "subject": { "type": "string", "description": "Subject of the email template. Can be up to 255 characters.", - "x-example": "<SUBJECT>", - "x-nullable": true + "example": "<SUBJECT>", + "nullable": true }, "message": { "type": "string", "description": "Plain or HTML body of the email template message. Can be up to 10MB of content.", - "x-example": "<MESSAGE>", - "x-nullable": true + "example": "<MESSAGE>", + "nullable": true }, "senderName": { "type": "string", "description": "Name of the email sender.", - "x-example": "<SENDER_NAME>", - "x-nullable": true + "example": "<SENDER_NAME>", + "nullable": true }, "senderEmail": { "type": "string", "description": "Email of the sender. Pass an empty string to clear a previously set value.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "replyToEmail": { "type": "string", "description": "Reply to email. Pass an empty string to clear a previously set value.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "replyToName": { "type": "string", "description": "Reply to name.", - "x-example": "<REPLY_TO_NAME>", - "x-nullable": true + "example": "<REPLY_TO_NAME>", + "nullable": true } }, "required": [ @@ -65749,7 +65641,7 @@ "required": true, "schema": { "type": "string", - "x-example": "verification", + "example": "verification", "enum": [ "verification", "magicSession", @@ -65778,7 +65670,7 @@ "required": false, "schema": { "type": "string", - "x-example": "af", + "example": "af", "enum": [ "af", "ar-ae", @@ -66105,7 +65997,7 @@ "schema": { "type": "string", "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "in": "query" }, @@ -66116,7 +66008,7 @@ "schema": { "type": "string", "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "in": "query" }, @@ -66126,7 +66018,7 @@ "required": false, "schema": { "type": "string", - "x-example": "1h", + "example": "1h", "enum": [ "1h", "1d" @@ -66209,7 +66101,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -66270,7 +66162,7 @@ "variableId": { "type": "string", "description": "Variable unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<VARIABLE_ID>", + "example": "<VARIABLE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -66278,18 +66170,18 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "<KEY>" + "example": "<KEY>" }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "<VALUE>" + "example": "<VALUE>" }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -66356,7 +66248,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -66414,7 +66306,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -66428,20 +66320,20 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "<KEY>", - "x-nullable": true + "example": "<KEY>", + "nullable": true }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "<VALUE>", - "x-nullable": true + "example": "<VALUE>", + "nullable": true }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -66494,7 +66386,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -66553,7 +66445,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -66612,7 +66504,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -66671,7 +66563,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -66681,7 +66573,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ADDON_ID>" + "example": "<ADDON_ID>" }, "in": "path" } @@ -66734,7 +66626,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -66744,7 +66636,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ADDON_ID>" + "example": "<ADDON_ID>" }, "in": "path" } @@ -66803,7 +66695,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -66813,7 +66705,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ADDON_ID>" + "example": "<ADDON_ID>" }, "in": "path" } @@ -66872,7 +66764,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -66882,7 +66774,7 @@ "required": true, "schema": { "type": "string", - "x-example": "baa" + "example": "baa" }, "in": "path" } @@ -66937,7 +66829,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -66995,7 +66887,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -67066,7 +66958,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -67076,7 +66968,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -67132,7 +67024,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -67142,7 +67034,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -67156,12 +67048,12 @@ "name": { "type": "string", "description": "Key name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime" } }, @@ -67217,7 +67109,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -67227,7 +67119,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -67286,7 +67178,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -67309,7 +67201,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -67367,7 +67259,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -67381,7 +67273,7 @@ "resourceType": { "type": "string", "description": "The resource type for the schedule. Possible values: function, execution, message, backup.", - "x-example": "function", + "example": "function", "enum": [ "function", "execution", @@ -67399,24 +67291,23 @@ "resourceId": { "type": "string", "description": "The resource ID to associate with this schedule.", - "x-example": "<RESOURCE_ID>" + "example": "<RESOURCE_ID>" }, "schedule": { "type": "string", - "description": "Schedule CRON expression.", - "x-example": null + "description": "Schedule CRON expression." }, "active": { "type": "boolean", "description": "Whether the schedule is active.", "default": false, - "x-example": false + "example": false }, "data": { "type": "object", "description": "Schedule data as a JSON string. Used to store resource-specific context needed for execution.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -67482,7 +67373,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -67492,7 +67383,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SCHEDULE_ID>" + "example": "<SCHEDULE_ID>" }, "in": "path" } @@ -67551,7 +67442,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -67610,7 +67501,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -67620,7 +67511,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<STAGE_ID>" + "example": "<STAGE_ID>" }, "in": "path" } @@ -67635,7 +67526,7 @@ "type": "boolean", "description": "Mark the stage as skipped.", "default": true, - "x-example": false + "example": false } } } @@ -67692,7 +67583,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -67706,7 +67597,7 @@ "status": { "type": "string", "description": "New status for the project", - "x-example": "active", + "example": "active", "enum": [ "active" ], @@ -67777,7 +67668,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -67791,7 +67682,7 @@ "teamId": { "type": "string", "description": "Team ID of the team to transfer project to.", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" } }, "required": [ @@ -67857,13 +67748,12 @@ "properties": { "domain": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Domain name." }, "type": { "type": "string", "description": "Type of reference passed. Allowed values are: tag, path, all", - "x-example": "tag", + "example": "tag", "enum": [ "tag", "path", @@ -67880,7 +67770,7 @@ "type": "string", "description": "Reference to invalidate. Depending on type this can be: cache tag name (up to 128 characters), URL path (up to 2048 characters). Not required when type is all.", "default": "", - "x-example": "<REFERENCE>" + "example": "<REFERENCE>" } }, "required": [ @@ -67959,7 +67849,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -68021,8 +67911,7 @@ "properties": { "domain": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Domain name." } }, "required": [ @@ -68088,19 +67977,18 @@ "properties": { "domain": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Domain name." }, "functionId": { "type": "string", "description": "ID of function to be executed.", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "branch": { "type": "string", "description": "Name of VCS branch to deploy changes automatically", "default": "", - "x-example": "<BRANCH>" + "example": "<BRANCH>" } }, "required": [ @@ -68167,19 +68055,18 @@ "properties": { "domain": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Domain name." }, "url": { "type": "string", "description": "Target URL of redirection", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "statusCode": { "type": "string", "description": "Status code of redirection", - "x-example": "301", + "example": "301", "enum": [ "301", "302", @@ -68197,12 +68084,12 @@ "resourceId": { "type": "string", "description": "ID of parent resource.", - "x-example": "<RESOURCE_ID>" + "example": "<RESOURCE_ID>" }, "resourceType": { "type": "string", "description": "Type of parent resource.", - "x-example": "site", + "example": "site", "enum": [ "site", "function" @@ -68281,19 +68168,18 @@ "properties": { "domain": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Domain name." }, "siteId": { "type": "string", "description": "ID of site to be executed.", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "branch": { "type": "string", "description": "Name of VCS branch to deploy changes automatically", "default": "", - "x-example": "<BRANCH>" + "example": "<BRANCH>" } }, "required": [ @@ -68359,7 +68245,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -68410,7 +68296,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -68470,7 +68356,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -68544,7 +68430,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -68606,7 +68492,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<REPORT_ID>" + "example": "<REPORT_ID>" }, "in": "path" } @@ -68658,7 +68544,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<REPORT_ID>" + "example": "<REPORT_ID>" }, "in": "path" } @@ -68719,7 +68605,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<REPORT_ID>" + "example": "<REPORT_ID>" }, "in": "path" }, @@ -68742,7 +68628,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -68804,7 +68690,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<REPORT_ID>" + "example": "<REPORT_ID>" }, "in": "path" }, @@ -68814,7 +68700,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSIGHT_ID>" + "example": "<INSIGHT_ID>" }, "in": "path" } @@ -68887,7 +68773,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -68898,7 +68784,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -68959,7 +68845,7 @@ "siteId": { "type": "string", "description": "Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<SITE_ID>", + "example": "<SITE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -68967,12 +68853,12 @@ "name": { "type": "string", "description": "Site name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "framework": { "type": "string", "description": "Sites framework.", - "x-example": "analog", + "example": "analog", "enum": [ "analog", "angular", @@ -69013,49 +68899,49 @@ "type": "boolean", "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", "default": true, - "x-example": false + "example": false }, "timeout": { "type": "integer", "description": "Maximum request time in seconds.", "default": 30, - "x-example": 1, + "example": 1, "format": "int32" }, "installCommand": { "type": "string", "description": "Install Command.", "default": "", - "x-example": "<INSTALL_COMMAND>" + "example": "<INSTALL_COMMAND>" }, "buildCommand": { "type": "string", "description": "Build Command.", "default": "", - "x-example": "<BUILD_COMMAND>" + "example": "<BUILD_COMMAND>" }, "startCommand": { "type": "string", "description": "Custom start command. Leave empty to use default.", "default": "", - "x-example": "<START_COMMAND>" + "example": "<START_COMMAND>" }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", "default": "", - "x-example": "<OUTPUT_DIRECTORY>" + "example": "<OUTPUT_DIRECTORY>" }, "buildRuntime": { "type": "string", "description": "Runtime to use during build step.", - "x-example": "node-14.5", + "example": "node-14.5", "enum": [ "node-14.5", "node-16.0", @@ -69089,9 +68975,6 @@ "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", @@ -69187,9 +69070,6 @@ "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", @@ -69255,7 +69135,7 @@ "adapter": { "type": "string", "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "x-example": "static", + "example": "static", "enum": [ "static", "ssr" @@ -69270,43 +69150,42 @@ "type": "string", "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", "default": "", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "fallbackFile": { "type": "string", "description": "Fallback file for single page application sites.", "default": "", - "x-example": "<FALLBACK_FILE>" + "example": "<FALLBACK_FILE>" }, "providerRepositoryId": { "type": "string", "description": "Repository ID of the repo linked to the site.", "default": "", - "x-example": "<PROVIDER_REPOSITORY_ID>" + "example": "<PROVIDER_REPOSITORY_ID>" }, "providerBranch": { "type": "string", "description": "Production branch for the repo linked to the site.", "default": "", - "x-example": "<PROVIDER_BRANCH>" + "example": "<PROVIDER_BRANCH>" }, "providerSilentMode": { "type": "boolean", "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", "default": false, - "x-example": false + "example": false }, "providerRootDirectory": { "type": "string", "description": "Path to site code in the linked repo.", "default": "", - "x-example": "<PROVIDER_ROOT_DIRECTORY>" + "example": "<PROVIDER_ROOT_DIRECTORY>" }, "providerBranches": { "type": "array", "description": "List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -69315,7 +69194,6 @@ "type": "array", "description": "List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -69323,27 +69201,24 @@ "buildSpecification": { "type": "string", "description": "Build specification for the site deployments.", - "default": {}, - "x-example": null + "default": {} }, "runtimeSpecification": { "type": "string", "description": "Runtime specification for the SSR executions.", - "default": {}, - "x-example": null + "default": {} }, "deploymentRetention": { "type": "integer", "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "scopes": { "type": "array", "description": "List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -69677,7 +69552,7 @@ "required": false, "schema": { "type": "string", - "x-example": "runtimes", + "example": "runtimes", "default": "runtimes" }, "in": "query" @@ -69821,7 +69696,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -69833,7 +69708,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -69892,7 +69767,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEMPLATE_ID>" + "example": "<TEMPLATE_ID>" }, "in": "path" } @@ -69952,7 +69827,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -70010,7 +69885,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -70024,12 +69899,12 @@ "name": { "type": "string", "description": "Site name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "framework": { "type": "string", "description": "Sites framework.", - "x-example": "analog", + "example": "analog", "enum": [ "analog", "angular", @@ -70070,49 +69945,49 @@ "type": "boolean", "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", "default": true, - "x-example": false + "example": false }, "timeout": { "type": "integer", "description": "Maximum request time in seconds.", "default": 30, - "x-example": 1, + "example": 1, "format": "int32" }, "installCommand": { "type": "string", "description": "Install Command.", "default": "", - "x-example": "<INSTALL_COMMAND>" + "example": "<INSTALL_COMMAND>" }, "buildCommand": { "type": "string", "description": "Build Command.", "default": "", - "x-example": "<BUILD_COMMAND>" + "example": "<BUILD_COMMAND>" }, "startCommand": { "type": "string", "description": "Custom start command. Leave empty to use default.", "default": "", - "x-example": "<START_COMMAND>" + "example": "<START_COMMAND>" }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", "default": "", - "x-example": "<OUTPUT_DIRECTORY>" + "example": "<OUTPUT_DIRECTORY>" }, "buildRuntime": { "type": "string", "description": "Runtime to use during build step.", - "x-example": "node-14.5", + "example": "node-14.5", "enum": [ "node-14.5", "node-16.0", @@ -70146,9 +70021,6 @@ "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", @@ -70244,9 +70116,6 @@ "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", @@ -70312,7 +70181,7 @@ "adapter": { "type": "string", "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "x-example": "static", + "example": "static", "enum": [ "static", "ssr" @@ -70327,79 +70196,74 @@ "type": "string", "description": "Fallback file for single page application sites.", "default": "", - "x-example": "<FALLBACK_FILE>" + "example": "<FALLBACK_FILE>" }, "installationId": { "type": "string", "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", "default": "", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "providerRepositoryId": { "type": "string", "description": "Repository ID of the repo linked to the site.", "default": "", - "x-example": "<PROVIDER_REPOSITORY_ID>" + "example": "<PROVIDER_REPOSITORY_ID>" }, "providerBranch": { "type": "string", "description": "Production branch for the repo linked to the site.", "default": "", - "x-example": "<PROVIDER_BRANCH>" + "example": "<PROVIDER_BRANCH>" }, "providerSilentMode": { "type": "boolean", "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", "default": false, - "x-example": false + "example": false }, "providerRootDirectory": { "type": "string", "description": "Path to site code in the linked repo.", "default": "", - "x-example": "<PROVIDER_ROOT_DIRECTORY>" + "example": "<PROVIDER_ROOT_DIRECTORY>" }, "providerBranches": { "type": "array", "description": "List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "providerPaths": { "type": "array", "description": "List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "buildSpecification": { "type": "string", "description": "Build specification for the site deployments.", - "x-example": null, - "x-nullable": true + "nullable": true }, "runtimeSpecification": { "type": "string", "description": "Runtime specification for the SSR executions.", - "default": {}, - "x-example": null + "default": {} }, "deploymentRetention": { "type": "integer", "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "scopes": { "type": "array", "description": "List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -70618,7 +70482,7 @@ "usage.read" ] }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -70675,7 +70539,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -70735,7 +70599,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -70749,7 +70613,7 @@ "deploymentId": { "type": "string", "description": "Deployment ID.", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" } }, "required": [ @@ -70814,7 +70678,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -70837,7 +70701,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -70848,7 +70712,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -70907,7 +70771,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -70921,32 +70785,31 @@ "installCommand": { "type": "string", "description": "Install Commands.", - "x-example": "<INSTALL_COMMAND>", - "x-nullable": true + "example": "<INSTALL_COMMAND>", + "nullable": true }, "buildCommand": { "type": "string", "description": "Build Commands.", - "x-example": "<BUILD_COMMAND>", - "x-nullable": true + "example": "<BUILD_COMMAND>", + "nullable": true }, "outputDirectory": { "type": "string", "description": "Output Directory.", - "x-example": "<OUTPUT_DIRECTORY>", - "x-nullable": true + "example": "<OUTPUT_DIRECTORY>", + "nullable": true }, "code": { "type": "string", "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", - "x-example": null, "format": "binary" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -71011,7 +70874,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -71025,7 +70888,7 @@ "deploymentId": { "type": "string", "description": "Deployment ID.", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" } }, "required": [ @@ -71090,7 +70953,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -71104,22 +70967,22 @@ "repository": { "type": "string", "description": "Repository name of the template.", - "x-example": "<REPOSITORY>" + "example": "<REPOSITORY>" }, "owner": { "type": "string", "description": "The name of the owner of the template.", - "x-example": "<OWNER>" + "example": "<OWNER>" }, "rootDirectory": { "type": "string", "description": "Path to site code in the template repo.", - "x-example": "<ROOT_DIRECTORY>" + "example": "<ROOT_DIRECTORY>" }, "type": { "type": "string", "description": "Type for the reference provided. Can be commit, branch, or tag", - "x-example": "branch", + "example": "branch", "enum": [ "branch", "commit", @@ -71135,13 +70998,13 @@ "reference": { "type": "string", "description": "Reference value, can be a commit hash, branch name, or release tag", - "x-example": "<REFERENCE>" + "example": "<REFERENCE>" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -71210,7 +71073,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -71224,7 +71087,7 @@ "type": { "type": "string", "description": "Type of reference passed. Allowed values are: branch, commit", - "x-example": "branch", + "example": "branch", "enum": [ "branch", "commit", @@ -71240,13 +71103,13 @@ "reference": { "type": "string", "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", - "x-example": "<REFERENCE>" + "example": "<REFERENCE>" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -71312,7 +71175,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -71322,7 +71185,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" } @@ -71373,7 +71236,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -71383,7 +71246,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" } @@ -71450,7 +71313,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -71460,7 +71323,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" }, @@ -71470,7 +71333,7 @@ "required": false, "schema": { "type": "string", - "x-example": "source", + "example": "source", "enum": [ "source", "output" @@ -71490,7 +71353,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TOKEN>", + "example": "<TOKEN>", "default": "" }, "in": "query" @@ -71551,7 +71414,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -71561,7 +71424,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" } @@ -71621,7 +71484,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -71644,7 +71507,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -71705,7 +71568,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -71715,7 +71578,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<LOG_ID>" + "example": "<LOG_ID>" }, "in": "path" } @@ -71769,7 +71632,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -71779,7 +71642,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<LOG_ID>" + "example": "<LOG_ID>" }, "in": "path" } @@ -71839,7 +71702,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -71862,7 +71725,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -71921,7 +71784,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -71935,7 +71798,7 @@ "variableId": { "type": "string", "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<VARIABLE_ID>", + "example": "<VARIABLE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -71943,18 +71806,18 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "<KEY>" + "example": "<KEY>" }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "<VALUE>" + "example": "<VALUE>" }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -72021,7 +71884,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -72031,7 +71894,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -72089,7 +71952,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -72099,7 +71962,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -72113,20 +71976,20 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "<KEY>", - "x-nullable": true + "example": "<KEY>", + "nullable": true }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "<VALUE>", - "x-nullable": true + "example": "<VALUE>", + "nullable": true }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -72179,7 +72042,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -72189,7 +72052,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -72263,7 +72126,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -72274,7 +72137,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -72336,7 +72199,7 @@ "bucketId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<BUCKET_ID>", + "example": "<BUCKET_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -72344,41 +72207,42 @@ "name": { "type": "string", "description": "Bucket name", - "x-example": "<NAME>" + "example": "<NAME>" }, "permissions": { "type": "array", "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "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 + "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 + "example": false }, "maximumFileSize": { "type": "integer", "description": "Maximum file size allowed in bytes. Maximum allowed value is 0B.", "default": {}, - "x-example": 1, + "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" } @@ -72387,7 +72251,7 @@ "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", + "example": "none", "enum": [ "none", "gzip", @@ -72404,19 +72268,19 @@ "type": "boolean", "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", "default": true, - "x-example": false + "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 + "example": false }, "transformations": { "type": "boolean", "description": "Are image transformations enabled?", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -72483,7 +72347,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" } @@ -72542,7 +72406,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" } @@ -72556,41 +72420,42 @@ "name": { "type": "string", "description": "Bucket name", - "x-example": "<NAME>" + "example": "<NAME>" }, "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "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 + "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 + "example": false }, "maximumFileSize": { "type": "integer", "description": "Maximum file size allowed in bytes. Maximum allowed value is 0B.", "default": {}, - "x-example": 1, + "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" } @@ -72599,7 +72464,7 @@ "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", + "example": "none", "enum": [ "none", "gzip", @@ -72616,19 +72481,19 @@ "type": "boolean", "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", "default": true, - "x-example": false + "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 + "example": false }, "transformations": { "type": "boolean", "description": "Are image transformations enabled?", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -72685,7 +72550,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" } @@ -72749,7 +72614,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -72772,7 +72637,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -72783,7 +72648,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -72846,7 +72711,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" } @@ -72860,7 +72725,7 @@ "fileId": { "type": "string", "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<FILE_ID>", + "example": "<FILE_ID>", "x-upload-id": true, "x-appwrite": { "idGenerator": "ID.unique" @@ -72869,23 +72734,23 @@ "file": { "type": "string", "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "x-example": null, "format": "binary" }, "permissions": { "type": "array", "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "folder": { "type": "string", "description": "Virtual folder to place the file in, for example \"photos\/2026\". Nest folders with `\/`. Defaults to the bucket root.", - "default": "", - "x-example": null + "default": "" } }, "required": [ @@ -72955,7 +72820,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -72965,7 +72830,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" } @@ -73027,7 +72892,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -73037,7 +72902,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" } @@ -73051,16 +72916,18 @@ "name": { "type": "string", "description": "File name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true } } } @@ -73117,7 +72984,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -73127,7 +72994,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" } @@ -73194,7 +73061,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -73204,7 +73071,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" }, @@ -73214,7 +73081,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TOKEN>", + "example": "<TOKEN>", "default": "" }, "in": "query" @@ -73282,7 +73149,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -73292,7 +73159,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" }, @@ -73303,7 +73170,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -73315,7 +73182,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -73326,7 +73193,7 @@ "required": false, "schema": { "type": "string", - "x-example": "center", + "example": "center", "enum": [ "center", "top-left", @@ -73361,7 +73228,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -73373,7 +73240,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -73395,7 +73262,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -73407,7 +73274,7 @@ "schema": { "type": "number", "format": "float", - "x-example": 0, + "example": 0, "default": 1 }, "in": "query" @@ -73419,7 +73286,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -360, + "example": -360, "default": 0 }, "in": "query" @@ -73440,7 +73307,7 @@ "required": false, "schema": { "type": "string", - "x-example": "jpg", + "example": "jpg", "enum": [ "jpg", "jpeg", @@ -73469,7 +73336,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TOKEN>", + "example": "<TOKEN>", "default": "" }, "in": "query" @@ -73537,7 +73404,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -73547,7 +73414,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" }, @@ -73557,7 +73424,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TOKEN>", + "example": "<TOKEN>", "default": "" }, "in": "query" @@ -73632,7 +73499,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -73643,7 +73510,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -73705,7 +73572,7 @@ "databaseId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -73713,32 +73580,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.", "default": "serverless", - "x-example": "serverless" + "example": "serverless" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } }, "required": [ @@ -73930,7 +73797,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -74000,7 +73867,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -74065,7 +73932,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -74080,13 +73947,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -74146,7 +74013,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -74213,7 +74080,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -74228,7 +74095,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"tableId\": \"<TABLE_ID>\",\n\t \"rowId\": \"<ROW_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "<DATABASE_ID>", + "tableId": "<TABLE_ID>", + "rowId": "<ROW_ID>", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -74294,7 +74171,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -74353,7 +74230,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -74367,32 +74244,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.", - "x-example": "serverless", - "x-nullable": true + "example": "serverless", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } } } @@ -74446,7 +74323,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -74506,7 +74383,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -74520,8 +74397,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -74583,7 +74460,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -74641,7 +74518,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -74655,13 +74532,13 @@ "specification": { "type": "string", "description": "Dedicated compute specification to provision as the migration target (e.g. s-2vcpu-4gb). The migration always targets a dedicated compute, so `serverless` is not accepted.", - "x-example": "s-1vcpu-1gb" + "example": "s-1vcpu-1gb" }, "autoCutover": { "type": "boolean", "description": "Whether to cut over automatically once the copy is verified. When disabled the migration parks at ready_to_cutover and holds there until the cutover is performed manually.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -74726,7 +74603,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74736,7 +74613,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MIGRATION_ID>" + "example": "<MIGRATION_ID>" }, "in": "path" } @@ -74790,7 +74667,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74800,7 +74677,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MIGRATION_ID>" + "example": "<MIGRATION_ID>" }, "in": "path" } @@ -74860,7 +74737,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74870,7 +74747,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MIGRATION_ID>" + "example": "<MIGRATION_ID>" }, "in": "path" } @@ -74930,7 +74807,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74940,7 +74817,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -74951,7 +74828,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -74963,7 +74840,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -75024,7 +74901,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -75084,7 +74961,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -75148,7 +75025,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -75171,7 +75048,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -75182,7 +75059,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -75245,7 +75122,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -75259,7 +75136,7 @@ "tableId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<TABLE_ID>", + "example": "<TABLE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -75267,34 +75144,35 @@ "name": { "type": "string", "description": "Table name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "rowSecurity": { "type": "boolean", "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "columns": { "type": "array", "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, varchar, text, mediumtext, longtext, integer, bigint, double, boolean, datetime, point, linestring, polygon, email, url, ip, enum), size (integer, required for string and varchar types), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -75303,7 +75181,6 @@ "type": "array", "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", "default": [], - "x-example": null, "items": { "type": "object" } @@ -75376,7 +75253,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -75386,7 +75263,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -75448,7 +75325,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -75458,7 +75335,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -75472,34 +75349,36 @@ "name": { "type": "string", "description": "Table name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "rowSecurity": { "type": "boolean", "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "purge": { "type": "boolean", "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", "default": false, - "x-example": false + "example": false } } } @@ -75556,7 +75435,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -75566,7 +75445,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -75632,7 +75511,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -75642,7 +75521,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -75665,7 +75544,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -75732,7 +75611,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -75742,7 +75621,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -75755,40 +75634,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when column is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -75860,7 +75735,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -75870,7 +75745,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -75893,34 +75768,30 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when column is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -75992,7 +75863,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -76002,7 +75873,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -76015,25 +75886,24 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "boolean", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -76105,7 +75975,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -76115,7 +75985,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -76138,19 +76008,18 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "boolean", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -76222,7 +76091,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -76232,7 +76101,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -76245,26 +76114,25 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -76336,7 +76204,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -76346,7 +76214,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -76369,20 +76237,19 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -76454,7 +76321,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -76464,7 +76331,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -76477,26 +76344,25 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -76568,7 +76434,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -76578,7 +76444,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -76601,20 +76467,19 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -76686,7 +76551,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -76696,7 +76561,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -76709,13 +76574,11 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "elements": { "type": "array", "description": "Array of enum values.", - "x-example": null, "items": { "type": "string" } @@ -76723,19 +76586,19 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -76808,7 +76671,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -76818,7 +76681,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -76841,7 +76704,6 @@ "elements": { "type": "array", "description": "Updated list of enum values.", - "x-example": null, "items": { "type": "string" } @@ -76849,19 +76711,18 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -76934,7 +76795,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -76944,7 +76805,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -76957,40 +76818,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "number", "description": "Minimum value", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "max": { "type": "number", "description": "Maximum value", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "default": { "type": "number", "description": "Default value. Cannot be set when required.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -77062,7 +76919,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -77072,7 +76929,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -77095,34 +76952,30 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "number", "description": "Minimum value", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "max": { "type": "number", "description": "Maximum value", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "default": { "type": "number", "description": "Default value. Cannot be set when required.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -77194,7 +77047,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -77204,7 +77057,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -77217,40 +77070,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when column is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -77322,7 +77171,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -77332,7 +77181,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -77355,34 +77204,30 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when column is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -77454,7 +77299,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -77464,7 +77309,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -77477,25 +77322,23 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -77567,7 +77410,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -77577,7 +77420,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -77600,19 +77443,17 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -77684,7 +77525,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -77694,7 +77535,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -77707,18 +77548,30 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]]", + "example": [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ] + ], "items": { "type": "array", "items": { @@ -77726,7 +77579,7 @@ "format": "double" } }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -77798,7 +77651,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -77808,7 +77661,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -77831,12 +77684,25 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]]", + "example": [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ] + ], "items": { "type": "array", "items": { @@ -77844,13 +77710,12 @@ "format": "double" } }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -77921,7 +77786,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -77931,7 +77796,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -77944,31 +77809,30 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false }, "encrypt": { "type": "boolean", "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -78040,7 +77904,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -78050,7 +77914,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -78073,19 +77937,18 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -78157,7 +78020,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -78167,7 +78030,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -78180,31 +78043,30 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false }, "encrypt": { "type": "boolean", "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -78276,7 +78138,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -78286,7 +78148,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -78309,19 +78171,18 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -78393,7 +78254,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -78403,7 +78264,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -78416,23 +78277,25 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]", + "example": [ + 1, + 2 + ], "items": { "type": "number", "format": "double" }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -78504,7 +78367,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -78514,7 +78377,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -78537,23 +78400,25 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]", + "example": [ + 1, + 2 + ], "items": { "type": "number", "format": "double" }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -78624,7 +78489,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -78634,7 +78499,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -78647,18 +78512,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]]]", + "example": [ + [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ], + [ + 1, + 2 + ] + ] + ], "items": { "type": "array", "items": { @@ -78669,7 +78552,7 @@ } } }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -78741,7 +78624,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -78751,7 +78634,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -78774,12 +78657,31 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]]]", + "example": [ + [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ], + [ + 1, + 2 + ] + ] + ], "items": { "type": "array", "items": { @@ -78790,13 +78692,12 @@ } } }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -78867,7 +78768,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -78877,7 +78778,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -78891,12 +78792,12 @@ "relatedTableId": { "type": "string", "description": "Related Table ID.", - "x-example": "<RELATED_TABLE_ID>" + "example": "<RELATED_TABLE_ID>" }, "type": { "type": "string", "description": "Relationship type. Possible values are: oneToOne, oneToMany, manyToOne, manyToMany.", - "x-example": "oneToOne", + "example": "oneToOne", "enum": [ "oneToOne", "manyToOne", @@ -78915,25 +78816,23 @@ "type": "boolean", "description": "Is Two Way?", "default": false, - "x-example": false + "example": false }, "key": { "type": "string", "description": "Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true }, "twoWayKey": { "type": "string", "description": "Two Way Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true }, "onDelete": { "type": "string", "description": "Delete constraint. Possible values are: cascade, restrict, setNull.", "default": "restrict", - "x-example": "cascade", + "example": "cascade", "enum": [ "cascade", "restrict", @@ -79020,7 +78919,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -79030,7 +78929,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -79043,37 +78942,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "size": { "type": "integer", "description": "Column size for text columns, in number of characters.", - "x-example": 1, + "example": 1, "format": "int32" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false }, "encrypt": { "type": "boolean", "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -79150,7 +79048,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -79160,7 +79058,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -79183,26 +79081,25 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "size": { "type": "integer", "description": "Maximum size of the string column.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -79274,7 +79171,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -79284,7 +79181,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -79297,31 +79194,30 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false }, "encrypt": { "type": "boolean", "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -79393,7 +79289,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -79403,7 +79299,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -79426,19 +79322,18 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -79510,7 +79405,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -79520,7 +79415,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -79533,26 +79428,25 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -79624,7 +79518,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -79634,7 +79528,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -79657,20 +79551,19 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -79742,7 +79635,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -79752,7 +79645,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -79765,37 +79658,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "size": { "type": "integer", "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", - "x-example": 1, + "example": 1, "format": "int32" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false }, "encrypt": { "type": "boolean", "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -79868,7 +79760,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -79878,7 +79770,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -79901,26 +79793,25 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "size": { "type": "integer", "description": "Maximum size of the varchar column.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -80074,7 +79965,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -80084,7 +79975,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -80150,7 +80041,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -80160,7 +80051,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -80235,7 +80126,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -80245,7 +80136,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -80268,7 +80159,7 @@ "onDelete": { "type": "string", "description": "Delete constraint. Possible values are: cascade, restrict, setNull.", - "x-example": "cascade", + "example": "cascade", "enum": [ "cascade", "restrict", @@ -80280,13 +80171,12 @@ "restrict", "setNull" ], - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -80353,7 +80243,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -80363,7 +80253,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -80386,7 +80276,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -80450,7 +80340,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -80460,7 +80350,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -80473,13 +80363,12 @@ "properties": { "key": { "type": "string", - "description": "Index Key.", - "x-example": null + "description": "Index Key." }, "type": { "type": "string", "description": "Index type.", - "x-example": "key", + "example": "key", "enum": [ "key", "fulltext", @@ -80497,7 +80386,6 @@ "columns": { "type": "array", "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", - "x-example": null, "items": { "type": "string" } @@ -80506,7 +80394,6 @@ "type": "array", "description": "Array of index orders. Maximum of 100 orders are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -80524,7 +80411,6 @@ "type": "array", "description": "Length of index. Maximum of 100", "default": [], - "x-example": null, "items": { "type": "integer" } @@ -80599,7 +80485,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -80609,7 +80495,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -80674,7 +80560,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -80684,7 +80570,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -80760,7 +80646,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -80770,7 +80656,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -80793,7 +80679,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" }, @@ -80803,7 +80689,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -80815,7 +80701,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -80942,7 +80828,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -80952,7 +80838,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -80966,7 +80852,7 @@ "rowId": { "type": "string", "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<ROW_ID>", + "example": "<ROW_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -80975,22 +80861,29 @@ "type": "object", "description": "Row data as JSON object.", "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "rows": { "type": "array", "description": "Array of rows data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -80998,8 +80891,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } }, "required": [ @@ -81097,7 +80990,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -81107,7 +81000,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -81121,7 +81014,6 @@ "rows": { "type": "array", "description": "Array of row data as JSON objects. May contain partial rows.", - "x-example": null, "items": { "type": "object" } @@ -81129,8 +81021,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } }, "required": [ @@ -81197,7 +81089,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -81207,7 +81099,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -81222,13 +81114,18 @@ "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}" + "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" } @@ -81236,8 +81133,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -81301,7 +81198,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -81311,7 +81208,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -81334,7 +81231,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -81401,7 +81298,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -81411,7 +81308,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -81421,7 +81318,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" }, @@ -81444,7 +81341,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -81541,7 +81438,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -81551,7 +81448,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -81561,7 +81458,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" } @@ -81576,22 +81473,30 @@ "type": "object", "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -81658,7 +81563,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -81668,7 +81573,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -81678,7 +81583,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" } @@ -81693,22 +81598,30 @@ "type": "object", "description": "Row data as JSON object. Include only columns 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}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -81768,7 +81681,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -81778,7 +81691,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -81788,7 +81701,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" }, @@ -81798,7 +81711,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -81865,7 +81778,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -81875,7 +81788,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -81885,7 +81798,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" }, @@ -81909,21 +81822,19 @@ "type": "number", "description": "Value to increment the column by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "min": { "type": "number", "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -81992,7 +81903,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -82002,7 +81913,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -82012,7 +81923,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" }, @@ -82036,21 +81947,19 @@ "type": "number", "description": "Value to increment the column by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "max": { "type": "number", "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -82129,7 +82038,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -82140,7 +82049,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -82205,7 +82114,7 @@ "teamId": { "type": "string", "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<TEAM_ID>", + "example": "<TEAM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -82213,7 +82122,7 @@ "name": { "type": "string", "description": "Team name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "roles": { "type": "array", @@ -82221,7 +82130,6 @@ "default": [ "owner" ], - "x-example": null, "items": { "type": "string" } @@ -82294,7 +82202,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -82356,7 +82264,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -82370,7 +82278,7 @@ "name": { "type": "string", "description": "New team name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -82430,7 +82338,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -82493,7 +82401,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -82516,7 +82424,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -82578,7 +82486,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -82592,13 +82500,13 @@ "appId": { "type": "string", "description": "Application unique ID.", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" } }, "required": [ @@ -82666,7 +82574,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -82676,7 +82584,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -82737,7 +82645,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -82747,7 +82655,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -82761,8 +82669,8 @@ "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.", - "x-example": "<AUTHORIZATION_DETAILS>", - "x-nullable": true + "example": "<AUTHORIZATION_DETAILS>", + "nullable": true } } } @@ -82821,7 +82729,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -82831,7 +82739,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -82890,7 +82798,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -82913,7 +82821,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -82978,7 +82886,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -83001,7 +82909,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -83012,7 +82920,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -83075,7 +82983,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -83090,26 +82998,25 @@ "type": "string", "description": "Email of the new team member.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "userId": { "type": "string", "description": "ID of the user to be added to a team.", "default": "", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "roles": { "type": "array", "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", - "x-example": null, "items": { "type": "string" } @@ -83118,14 +83025,14 @@ "type": "string", "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "name": { "type": "string", "description": "Name of the new team member. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -83194,7 +83101,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -83204,7 +83111,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -83266,7 +83173,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -83276,7 +83183,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -83290,7 +83197,6 @@ "roles": { "type": "array", "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", - "x-example": null, "items": { "type": "string" } @@ -83353,7 +83259,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -83363,7 +83269,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -83426,7 +83332,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -83436,7 +83342,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -83450,12 +83356,12 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "secret": { "type": "string", "description": "Secret key.", - "x-example": "<SECRET>" + "example": "<SECRET>" } }, "required": [ @@ -83524,7 +83430,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -83585,7 +83491,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -83600,7 +83506,7 @@ "type": "object", "description": "Prefs key-value JSON object.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -83665,7 +83571,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -83675,7 +83581,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" }, @@ -83698,7 +83604,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -83757,7 +83663,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -83767,7 +83673,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" } @@ -83781,9 +83687,9 @@ "expire": { "type": "string", "description": "Token expiry date", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -83845,7 +83751,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOKEN_ID>" + "example": "<TOKEN_ID>" }, "in": "path" } @@ -83903,7 +83809,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOKEN_ID>" + "example": "<TOKEN_ID>" }, "in": "path" } @@ -83917,9 +83823,9 @@ "expire": { "type": "string", "description": "File token expiry date", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -83972,7 +83878,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOKEN_ID>" + "example": "<TOKEN_ID>" }, "in": "path" } @@ -84153,7 +84059,7 @@ "required": false, "schema": { "type": "string", - "x-example": "1m", + "example": "1m", "enum": [ "1m", "15m", @@ -84235,7 +84141,7 @@ "schema": { "type": "string", "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "default": "" }, "in": "query" @@ -84247,7 +84153,7 @@ "schema": { "type": "string", "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "default": "" }, "in": "query" @@ -84258,7 +84164,7 @@ "required": false, "schema": { "type": "string", - "x-example": "time", + "example": "time", "enum": [ "time", "value" @@ -84278,7 +84184,7 @@ "required": false, "schema": { "type": "string", - "x-example": "asc", + "example": "asc", "enum": [ "asc", "desc" @@ -84299,7 +84205,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 500 }, "in": "query" @@ -84311,7 +84217,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -84498,7 +84404,7 @@ "required": false, "schema": { "type": "string", - "x-example": "1m", + "example": "1m", "enum": [ "1m", "15m", @@ -84552,7 +84458,7 @@ "schema": { "type": "string", "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "default": "" }, "in": "query" @@ -84564,7 +84470,7 @@ "schema": { "type": "string", "format": "datetime", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "default": "" }, "in": "query" @@ -84575,7 +84481,7 @@ "required": false, "schema": { "type": "string", - "x-example": "time", + "example": "time", "enum": [ "time", "value" @@ -84595,7 +84501,7 @@ "required": false, "schema": { "type": "string", - "x-example": "asc", + "example": "asc", "enum": [ "asc", "desc" @@ -84616,7 +84522,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 500 }, "in": "query" @@ -84628,7 +84534,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -84639,7 +84545,7 @@ "required": false, "schema": { "type": "string", - "x-example": "last", + "example": "last", "default": "last" }, "in": "query" @@ -84714,7 +84620,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -84725,7 +84631,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -84787,7 +84693,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -84795,29 +84701,29 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone", - "x-nullable": true + "nullable": true }, "password": { "type": "string", "description": "Plain text user password. Must be at least 8 chars.", "default": "", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -84885,7 +84791,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -84893,20 +84799,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using Argon2.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -84976,7 +84882,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -84984,20 +84890,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using Bcrypt.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -85078,7 +84984,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -85089,7 +84995,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -85144,7 +85050,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<IDENTITY_ID>" + "example": "<IDENTITY_ID>" }, "in": "path" } @@ -85207,7 +85113,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -85215,20 +85121,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using MD5.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -85298,7 +85204,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -85306,20 +85212,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using PHPass.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -85389,7 +85295,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -85397,49 +85303,45 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using Scrypt.", - "x-example": "password", + "example": "password", "format": "password" }, "passwordSalt": { "type": "string", "description": "Optional salt used to hash password.", - "x-example": "<PASSWORD_SALT>" + "example": "<PASSWORD_SALT>" }, "passwordCpu": { "type": "integer", "description": "Optional CPU cost used to hash password.", - "x-example": null, "format": "int32" }, "passwordMemory": { "type": "integer", "description": "Optional memory cost used to hash password.", - "x-example": null, "format": "int32" }, "passwordParallel": { "type": "integer", "description": "Optional parallelization cost used to hash password.", - "x-example": null, "format": "int32" }, "passwordLength": { "type": "integer", "description": "Optional hash length used to hash password.", - "x-example": null, "format": "int32" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -85514,7 +85416,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -85522,35 +85424,35 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using Scrypt Modified.", - "x-example": "password", + "example": "password", "format": "password" }, "passwordSalt": { "type": "string", "description": "Salt used to hash password.", - "x-example": "<PASSWORD_SALT>" + "example": "<PASSWORD_SALT>" }, "passwordSaltSeparator": { "type": "string", "description": "Salt separator used to hash password.", - "x-example": "<PASSWORD_SALT_SEPARATOR>" + "example": "<PASSWORD_SALT_SEPARATOR>" }, "passwordSignerKey": { "type": "string", "description": "Signer key used to hash password.", - "x-example": "<PASSWORD_SIGNER_KEY>" + "example": "<PASSWORD_SIGNER_KEY>" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -85623,7 +85525,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -85631,19 +85533,19 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using SHA.", - "x-example": "password", + "example": "password", "format": "password" }, "passwordVersion": { "type": "string", "description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'", - "x-example": "sha1", + "example": "sha1", "enum": [ "sha1", "sha224", @@ -85676,7 +85578,7 @@ "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -85742,7 +85644,7 @@ "required": false, "schema": { "type": "string", - "x-example": "24h", + "example": "24h", "enum": [ "24h", "30d", @@ -85815,7 +85717,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -85867,7 +85769,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -85928,7 +85830,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -85942,7 +85844,7 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" } }, @@ -86009,7 +85911,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -86023,7 +85925,7 @@ "impersonator": { "type": "boolean", "description": "Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.", - "x-example": false + "example": false } }, "required": [ @@ -86089,7 +85991,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -86104,13 +86006,13 @@ "type": "string", "description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.", "default": "recent", - "x-example": "<SESSION_ID>" + "example": "<SESSION_ID>" }, "duration": { "type": "integer", "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", "default": 900, - "x-example": 0, + "example": 0, "format": "int32" } } @@ -86174,7 +86076,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -86188,7 +86090,6 @@ "labels": { "type": "array", "description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", - "x-example": null, "items": { "type": "string" } @@ -86257,7 +86158,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -86280,7 +86181,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -86342,7 +86243,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -86365,7 +86266,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -86376,7 +86277,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -86498,7 +86399,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -86512,7 +86413,7 @@ "mfa": { "type": "boolean", "description": "Enable or disable MFA.", - "x-example": false + "example": false } }, "required": [ @@ -86629,7 +86530,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -86639,7 +86540,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -86733,7 +86634,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -86743,7 +86644,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<CHALLENGE_ID>" + "example": "<CHALLENGE_ID>" }, "in": "path" } @@ -86860,7 +86761,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -86977,7 +86878,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87092,7 +86993,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87207,7 +87108,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87268,7 +87169,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87282,7 +87183,7 @@ "name": { "type": "string", "description": "User name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -87348,7 +87249,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87362,7 +87263,7 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -87429,7 +87330,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87443,7 +87344,7 @@ "number": { "type": "string", "description": "User phone number.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" } }, @@ -87510,7 +87411,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87569,7 +87470,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87584,7 +87485,7 @@ "type": "object", "description": "Prefs key-value JSON object.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -87653,7 +87554,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -87663,7 +87564,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -87729,7 +87630,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87784,7 +87685,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87841,7 +87742,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -87851,7 +87752,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SESSION_ID>" + "example": "<SESSION_ID>" }, "in": "path" } @@ -87912,7 +87813,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -87926,7 +87827,7 @@ "status": { "type": "boolean", "description": "User Status. To activate the user pass `true` and to block the user pass `false`.", - "x-example": false + "example": false } }, "required": [ @@ -87992,7 +87893,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -88015,7 +87916,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -88075,7 +87976,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -88089,7 +87990,7 @@ "targetId": { "type": "string", "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<TARGET_ID>", + "example": "<TARGET_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -88097,7 +87998,7 @@ "providerType": { "type": "string", "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email", + "example": "email", "enum": [ "email", "sms", @@ -88113,19 +88014,19 @@ "identifier": { "type": "string", "description": "The target identifier (token, email, phone etc.)", - "x-example": "<IDENTIFIER>" + "example": "<IDENTIFIER>" }, "providerId": { "type": "string", "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", "default": "", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "name": { "type": "string", "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -88193,7 +88094,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -88203,7 +88104,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TARGET_ID>" + "example": "<TARGET_ID>" }, "in": "path" } @@ -88262,7 +88163,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -88272,7 +88173,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TARGET_ID>" + "example": "<TARGET_ID>" }, "in": "path" } @@ -88287,19 +88188,19 @@ "type": "string", "description": "The target identifier (token, email, phone etc.)", "default": "", - "x-example": "<IDENTIFIER>" + "example": "<IDENTIFIER>" }, "providerId": { "type": "string", "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", "default": "", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "name": { "type": "string", "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } } } @@ -88353,7 +88254,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -88363,7 +88264,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TARGET_ID>" + "example": "<TARGET_ID>" }, "in": "path" } @@ -88424,7 +88325,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -88439,14 +88340,14 @@ "type": "integer", "description": "Token length in characters. The default length is 6 characters", "default": 6, - "x-example": 4, + "example": 4, "format": "int32" }, "expire": { "type": "integer", "description": "Token expiration period in seconds. The default expiration is 15 minutes.", "default": 900, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -88510,7 +88411,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -88524,7 +88425,7 @@ "emailVerification": { "type": "boolean", "description": "User email verification status.", - "x-example": false + "example": false } }, "required": [ @@ -88590,7 +88491,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -88604,7 +88505,7 @@ "phoneVerification": { "type": "boolean", "description": "User phone verification status.", - "x-example": false + "example": false } }, "required": [ @@ -88682,7 +88583,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -88696,12 +88597,12 @@ "providerRepositoryId": { "type": "string", "description": "Repository Id", - "x-example": "<PROVIDER_REPOSITORY_ID>" + "example": "<PROVIDER_REPOSITORY_ID>" }, "type": { "type": "string", "description": "Detector type. Must be one of the following: runtime, framework", - "x-example": "runtime", + "example": "runtime", "enum": [ "runtime", "framework" @@ -88716,7 +88617,7 @@ "type": "string", "description": "Path to Root Directory", "default": "", - "x-example": "<PROVIDER_ROOT_DIRECTORY>" + "example": "<PROVIDER_ROOT_DIRECTORY>" } }, "required": [ @@ -88795,7 +88696,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" }, @@ -88805,7 +88706,7 @@ "required": true, "schema": { "type": "string", - "x-example": "runtime", + "example": "runtime", "enum": [ "runtime", "framework" @@ -88824,7 +88725,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -88895,7 +88796,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -88909,18 +88810,18 @@ "name": { "type": "string", "description": "Repository name (slug)", - "x-example": "<NAME>" + "example": "<NAME>" }, "private": { "type": "boolean", "description": "Mark repository public or private", - "x-example": false + "example": false }, "providerNamespace": { "type": "string", "description": "Namespace of the git repository. Defaults to the installation's own namespace.", "default": "", - "x-example": "<PROVIDER_NAMESPACE>" + "example": "<PROVIDER_NAMESPACE>" } }, "required": [ @@ -88985,7 +88886,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" }, @@ -88995,7 +88896,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_REPOSITORY_ID>" + "example": "<PROVIDER_REPOSITORY_ID>" }, "in": "path" } @@ -89054,7 +88955,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" }, @@ -89064,7 +88965,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_REPOSITORY_ID>" + "example": "<PROVIDER_REPOSITORY_ID>" }, "in": "path" }, @@ -89074,7 +88975,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -89147,7 +89048,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" }, @@ -89157,7 +89058,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_REPOSITORY_ID>" + "example": "<PROVIDER_REPOSITORY_ID>" }, "in": "path" }, @@ -89167,7 +89068,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<PROVIDER_ROOT_DIRECTORY>", + "example": "<PROVIDER_ROOT_DIRECTORY>", "default": "" }, "in": "query" @@ -89178,7 +89079,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<PROVIDER_REFERENCE>", + "example": "<PROVIDER_REFERENCE>", "default": "" }, "in": "query" @@ -89234,7 +89135,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" }, @@ -89244,7 +89145,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<REPOSITORY_ID>" + "example": "<REPOSITORY_ID>" }, "in": "path" } @@ -89258,7 +89159,7 @@ "providerPullRequestId": { "type": "string", "description": "GitHub Pull Request Id", - "x-example": "<PROVIDER_PULL_REQUEST_ID>" + "example": "<PROVIDER_PULL_REQUEST_ID>" } }, "required": [ @@ -89335,7 +89236,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -89346,7 +89247,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -89406,7 +89307,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -89456,7 +89357,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -89514,7 +89415,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" }, @@ -89524,7 +89425,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -89612,7 +89513,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -89674,7 +89575,7 @@ "databaseId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -89682,32 +89583,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.", "default": "serverless", - "x-example": "serverless" + "example": "serverless" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } }, "required": [ @@ -89893,7 +89794,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -89960,7 +89861,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -90022,7 +89923,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -90037,13 +89938,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -90100,7 +90001,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -90164,7 +90065,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -90179,7 +90080,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "<DATABASE_ID>", + "collectionId": "<COLLECTION_ID>", + "documentId": "<DOCUMENT_ID>", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -90245,7 +90156,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -90304,7 +90215,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -90318,32 +90229,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.", - "x-example": "serverless", - "x-nullable": true + "example": "serverless", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } }, "required": [ @@ -90400,7 +90311,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -90461,7 +90372,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -90484,7 +90395,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -90495,7 +90406,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -90555,7 +90466,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -90569,7 +90480,7 @@ "collectionId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<COLLECTION_ID>", + "example": "<COLLECTION_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -90577,18 +90488,20 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "dimension": { "type": "integer", "description": "Embedding dimension.", - "x-example": 1, + "example": 1, "format": "int32" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -90597,13 +90510,13 @@ "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -90671,7 +90584,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -90681,7 +90594,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -90740,7 +90653,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -90750,7 +90663,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -90764,18 +90677,20 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "dimension": { "type": "integer", "description": "Embedding dimensions.", - "x-example": 1, + "example": 1, "format": "int32" }, "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -90784,13 +90699,13 @@ "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -90847,7 +90762,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -90857,7 +90772,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -90921,7 +90836,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -90931,7 +90846,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -90954,7 +90869,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" }, @@ -90964,7 +90879,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -90976,7 +90891,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -91098,7 +91013,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -91108,7 +91023,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -91122,7 +91037,7 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DOCUMENT_ID>", + "example": "<DOCUMENT_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -91131,12 +91046,24 @@ "type": "object", "description": "Document data as JSON object.", "default": {}, - "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" + "example": { + "embeddings": [ + 0.12, + -0.55, + 0.88, + 1.02 + ], + "metadata": { + "key": "value" + } + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -91145,7 +91072,6 @@ "type": "array", "description": "Array of documents data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -91153,7 +91079,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } }, "required": [ @@ -91248,7 +91174,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -91258,7 +91184,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -91272,7 +91198,6 @@ "documents": { "type": "array", "description": "Array of document data as JSON objects. May contain partial documents.", - "x-example": null, "items": { "type": "object" } @@ -91280,7 +91205,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } }, "required": [ @@ -91344,7 +91269,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -91354,7 +91279,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -91369,13 +91294,12 @@ "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", "default": [], - "x-example": "{}" + "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" } @@ -91383,7 +91307,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -91444,7 +91368,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -91454,7 +91378,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -91477,7 +91401,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -91541,7 +91465,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -91551,7 +91475,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -91566,7 +91490,6 @@ "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" } @@ -91574,19 +91497,19 @@ "transactionId": { "type": "string", "description": "Transaction ID to read uncommitted changes within the transaction.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "total": { "type": "boolean", "description": "When set to false, the total count returned will be 0 and will not be calculated.", "default": true, - "x-example": false + "example": false }, "ttl": { "type": "integer", "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } } @@ -91653,7 +91576,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -91663,7 +91586,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -91673,7 +91596,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -91696,7 +91619,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -91790,7 +91713,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -91800,7 +91723,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -91813,7 +91736,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" } @@ -91828,12 +91751,14 @@ "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -91841,7 +91766,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -91905,7 +91830,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -91915,7 +91840,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -91925,7 +91850,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" } @@ -91940,12 +91865,14 @@ "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -91953,7 +91880,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -92010,7 +91937,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -92020,7 +91947,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -92030,7 +91957,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -92040,7 +91967,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -92101,7 +92028,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -92111,7 +92038,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -92134,7 +92061,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -92194,7 +92121,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -92204,7 +92131,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -92217,13 +92144,12 @@ "properties": { "key": { "type": "string", - "description": "Index Key.", - "x-example": null + "description": "Index Key." }, "type": { "type": "string", "description": "Index type.", - "x-example": "hnsw_euclidean", + "example": "hnsw_euclidean", "enum": [ "hnsw_euclidean", "hnsw_dot", @@ -92245,7 +92171,6 @@ "attributes": { "type": "array", "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "x-example": null, "items": { "type": "string" } @@ -92254,7 +92179,6 @@ "type": "array", "description": "Array of index orders. Maximum of 100 orders are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -92272,7 +92196,6 @@ "type": "array", "description": "Length of index. Maximum of 100", "default": [], - "x-example": null, "items": { "type": "integer" } @@ -92343,7 +92266,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -92353,7 +92276,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -92414,7 +92337,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -92424,7 +92347,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -92493,7 +92416,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -92507,8 +92430,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -92570,7 +92493,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -92580,7 +92503,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -92591,7 +92514,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -92603,7 +92526,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -92664,7 +92587,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -92724,7 +92647,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -92798,7 +92721,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -92809,7 +92732,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -92873,7 +92796,7 @@ "ruleId": { "type": "string", "description": "Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.", - "x-example": "<RULE_ID>", + "example": "<RULE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -92881,43 +92804,42 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api" + "example": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Leave empty for the API resource type.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Optional description for the rule.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", "default": 0, - "x-example": -100000, + "example": -100000, "format": "int32" }, "enabled": { "type": "boolean", "description": "Set to false to create the rule in a disabled state.", "default": true, - "x-example": false + "example": false }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "default": [], - "x-example": null + "default": [] } }, "required": [ @@ -92985,7 +92907,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -92999,45 +92921,44 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api", - "x-nullable": true + "example": "api", + "nullable": true }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "<DESCRIPTION>", - "x-nullable": true + "example": "<DESCRIPTION>", + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", - "x-example": -100000, + "example": -100000, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Set to false to disable the rule.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -93102,7 +93023,7 @@ "ruleId": { "type": "string", "description": "Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.", - "x-example": "<RULE_ID>", + "example": "<RULE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -93110,62 +93031,61 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api" + "example": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Optional description for the rule.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "challengeType": { "type": "string", "description": "Challenge type enforced by the rule.", "default": "compute", - "x-example": "compute" + "example": "compute" }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", "default": 0, - "x-example": -100000, + "example": -100000, "format": "int32" }, "enabled": { "type": "boolean", "description": "Set to false to create the rule in a disabled state.", "default": true, - "x-example": false + "example": false }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "default": [], - "x-example": null + "default": [] }, "difficulty": { "type": "integer", "description": "Challenge difficulty from 1 (easiest) to 5 (hardest). Higher values demand more client-side proof-of-work.", "default": 3, - "x-example": 1, + "example": 1, "format": "int32" }, "ttl": { "type": "integer", "description": "How long, in seconds, a visitor stays cleared after passing the challenge before being challenged again.", "default": 1800, - "x-example": 900, + "example": 900, "format": "int32" } }, @@ -93234,7 +93154,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -93248,65 +93168,64 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api", - "x-nullable": true + "example": "api", + "nullable": true }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "<DESCRIPTION>", - "x-nullable": true + "example": "<DESCRIPTION>", + "nullable": true }, "challengeType": { "type": "string", "description": "Challenge type enforced by the rule.", - "x-example": "compute", - "x-nullable": true + "example": "compute", + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", - "x-example": -100000, + "example": -100000, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Set to false to disable the rule.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "x-example": null, - "x-nullable": true + "nullable": true }, "difficulty": { "type": "integer", "description": "Challenge difficulty from 1 (easiest) to 5 (hardest). Higher values demand more client-side proof-of-work.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "ttl": { "type": "integer", "description": "How long, in seconds, a visitor stays cleared after passing the challenge before being challenged again.", - "x-example": 900, + "example": 900, "format": "int32", - "x-nullable": true + "nullable": true } } } @@ -93371,7 +93290,7 @@ "ruleId": { "type": "string", "description": "Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.", - "x-example": "<RULE_ID>", + "example": "<RULE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -93379,43 +93298,42 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api" + "example": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Optional description for the rule.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", "default": 0, - "x-example": -100000, + "example": -100000, "format": "int32" }, "enabled": { "type": "boolean", "description": "Set to false to create the rule in a disabled state.", "default": true, - "x-example": false + "example": false }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "default": [], - "x-example": null + "default": [] } }, "required": [ @@ -93483,7 +93401,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -93497,45 +93415,44 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api", - "x-nullable": true + "example": "api", + "nullable": true }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "<DESCRIPTION>", - "x-nullable": true + "example": "<DESCRIPTION>", + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", - "x-example": -100000, + "example": -100000, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Set to false to disable the rule.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -93600,7 +93517,7 @@ "ruleId": { "type": "string", "description": "Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.", - "x-example": "<RULE_ID>", + "example": "<RULE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -93608,74 +93525,73 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api" + "example": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Optional description for the rule.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "limit": { "type": "integer", "description": "Maximum number of matching requests allowed in the configured interval.", - "x-example": 1, + "example": 1, "format": "int32" }, "interval": { "type": "integer", "description": "Interval in seconds used for rate limiting.", - "x-example": 1, + "example": 1, "format": "int32" }, "key": { "type": "string", "description": "Rate limit key. Use `ip` to limit per client IP or `userId` to limit per authenticated user. Requests without an authenticated user skip `userId` rules.", "default": "ip", - "x-example": "ip" + "example": "ip" }, "strategy": { "type": "string", "description": "Rate limit strategy. `fixedWindow` counts requests in discrete intervals, `slidingWindow` weights the previous interval for smoother limiting, and `tokenBucket` refills allowance continuously to permit short bursts.", "default": "fixedWindow", - "x-example": "fixedWindow" + "example": "fixedWindow" }, "maxBucketSize": { "type": "integer", "description": "Maximum number of tokens the bucket can hold for the `tokenBucket` strategy, controlling how large a burst is allowed. The sustained refill rate is `limit \/ interval`. Defaults to `limit` when omitted. Ignored by other strategies.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", "default": 0, - "x-example": -100000, + "example": -100000, "format": "int32" }, "enabled": { "type": "boolean", "description": "Set to false to create the rule in a disabled state.", "default": true, - "x-example": false + "example": false }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "default": [], - "x-example": null + "default": [] } }, "required": [ @@ -93745,7 +93661,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -93759,72 +93675,71 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api", - "x-nullable": true + "example": "api", + "nullable": true }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "<DESCRIPTION>", - "x-nullable": true + "example": "<DESCRIPTION>", + "nullable": true }, "limit": { "type": "integer", "description": "Maximum number of matching requests allowed in the configured interval.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "interval": { "type": "integer", "description": "Interval in seconds used for rate limiting.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "key": { "type": "string", "description": "Rate limit key. Use `ip` to limit per client IP or `userId` to limit per authenticated user. Requests without an authenticated user skip `userId` rules.", - "x-example": "ip", - "x-nullable": true + "example": "ip", + "nullable": true }, "maxBucketSize": { "type": "integer", "description": "Maximum number of tokens the bucket can hold for the `tokenBucket` strategy, controlling how large a burst is allowed. The sustained refill rate is `limit \/ interval`. Ignored by other strategies. The strategy itself cannot be changed after creation.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", - "x-example": -100000, + "example": -100000, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Set to false to disable the rule.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -93889,7 +93804,7 @@ "ruleId": { "type": "string", "description": "Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.", - "x-example": "<RULE_ID>", + "example": "<RULE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -93897,54 +93812,53 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api" + "example": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Optional description for the rule.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "location": { "type": "string", "description": "Location used for redirect responses.", - "x-example": "<LOCATION>" + "example": "<LOCATION>" }, "statusCode": { "type": "integer", "description": "Integer status code used for redirect responses.", - "x-example": 300, + "example": 300, "format": "int32" }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", "default": 0, - "x-example": -100000, + "example": -100000, "format": "int32" }, "enabled": { "type": "boolean", "description": "Set to false to create the rule in a disabled state.", "default": true, - "x-example": false + "example": false }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "default": [], - "x-example": null + "default": [] } }, "required": [ @@ -94014,7 +93928,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -94028,58 +93942,57 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api", - "x-nullable": true + "example": "api", + "nullable": true }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "<DESCRIPTION>", - "x-nullable": true + "example": "<DESCRIPTION>", + "nullable": true }, "location": { "type": "string", "description": "Location used for redirect responses.", - "x-example": "<LOCATION>", - "x-nullable": true + "example": "<LOCATION>", + "nullable": true }, "statusCode": { "type": "integer", "description": "Integer status code used for redirect responses.", - "x-example": 300, + "example": 300, "format": "int32", - "x-nullable": true + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", - "x-example": -100000, + "example": -100000, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Set to false to disable the rule.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -94142,7 +94055,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -94197,7 +94110,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -94270,7 +94183,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -94331,25 +94244,23 @@ "webhookId": { "type": "string", "description": "Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<WEBHOOK_ID>", + "example": "<WEBHOOK_ID>", "x-appwrite": { "idGenerator": "ID.unique" } }, "url": { "type": "string", - "description": "Webhook URL.", - "x-example": null + "description": "Webhook URL." }, "name": { "type": "string", "description": "Webhook name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "events": { "type": "array", "description": "Events list. Maximum of 100 events are allowed.", - "x-example": null, "items": { "type": "string" } @@ -94358,32 +94269,32 @@ "type": "boolean", "description": "Enable or disable a webhook.", "default": true, - "x-example": false + "example": false }, "tls": { "type": "boolean", "description": "Certificate verification, false for disabled or true for enabled.", "default": false, - "x-example": false + "example": false }, "authUsername": { "type": "string", "description": "Webhook HTTP user. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_USERNAME>" + "example": "<AUTH_USERNAME>" }, "authPassword": { "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "password", + "example": "password", "format": "password" }, "secret": { "type": "string", "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", - "x-example": "<SECRET>", - "x-nullable": true + "example": "<SECRET>", + "nullable": true } }, "required": [ @@ -94451,7 +94362,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<WEBHOOK_ID>" + "example": "<WEBHOOK_ID>" }, "in": "path" } @@ -94509,7 +94420,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<WEBHOOK_ID>" + "example": "<WEBHOOK_ID>" }, "in": "path" } @@ -94523,17 +94434,15 @@ "name": { "type": "string", "description": "Webhook name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "url": { "type": "string", - "description": "Webhook URL.", - "x-example": null + "description": "Webhook URL." }, "events": { "type": "array", "description": "Events list. Maximum of 100 events are allowed.", - "x-example": null, "items": { "type": "string" } @@ -94542,25 +94451,25 @@ "type": "boolean", "description": "Enable or disable a webhook.", "default": true, - "x-example": false + "example": false }, "tls": { "type": "boolean", "description": "Certificate verification, false for disabled or true for enabled.", "default": false, - "x-example": false + "example": false }, "authUsername": { "type": "string", "description": "Webhook HTTP user. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_USERNAME>" + "example": "<AUTH_USERNAME>" }, "authPassword": { "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -94619,7 +94528,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<WEBHOOK_ID>" + "example": "<WEBHOOK_ID>" }, "in": "path" } @@ -94679,7 +94588,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<WEBHOOK_ID>" + "example": "<WEBHOOK_ID>" }, "in": "path" } @@ -94693,8 +94602,8 @@ "secret": { "type": "string", "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", - "x-example": "<SECRET>", - "x-nullable": true + "example": "<SECRET>", + "nullable": true } } } @@ -94880,7 +94789,7 @@ "description": "Any", "type": "object", "additionalProperties": true, - "example": [] + "example": {} }, "rowList": { "description": "Rows List", @@ -94889,16 +94798,15 @@ "total": { "type": "integer", "description": "Total number of rows that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "rows": { "type": "array", "description": "List of rows.", "items": { "$ref": "#\/components\/schemas\/row" - }, - "x-example": "" + } } }, "required": [ @@ -94917,16 +94825,15 @@ "total": { "type": "integer", "description": "Total number of documents that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "documents": { "type": "array", "description": "List of documents.", "items": { "$ref": "#\/components\/schemas\/document" - }, - "x-example": "" + } } }, "required": [ @@ -94945,16 +94852,15 @@ "total": { "type": "integer", "description": "Total number of presences that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "presences": { "type": "array", "description": "List of presences.", "items": { "$ref": "#\/components\/schemas\/presence" - }, - "x-example": "" + } } }, "required": [ @@ -94973,16 +94879,15 @@ "total": { "type": "integer", "description": "Total number of tables that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "tables": { "type": "array", "description": "List of tables.", "items": { "$ref": "#\/components\/schemas\/table" - }, - "x-example": "" + } } }, "required": [ @@ -95001,16 +94906,15 @@ "total": { "type": "integer", "description": "Total number of collections that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "collections": { "type": "array", "description": "List of collections.", "items": { "$ref": "#\/components\/schemas\/collection" - }, - "x-example": "" + } } }, "required": [ @@ -95029,16 +94933,15 @@ "total": { "type": "integer", "description": "Total number of databases that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "databases": { "type": "array", "description": "List of databases.", "items": { "$ref": "#\/components\/schemas\/database" - }, - "x-example": "" + } } }, "required": [ @@ -95057,16 +94960,15 @@ "total": { "type": "integer", "description": "Total number of indexes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "indexes": { "type": "array", "description": "List of indexes.", "items": { "$ref": "#\/components\/schemas\/index" - }, - "x-example": "" + } } }, "required": [ @@ -95085,16 +94987,15 @@ "total": { "type": "integer", "description": "Total number of indexes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "indexes": { "type": "array", "description": "List of indexes.", "items": { "$ref": "#\/components\/schemas\/columnIndex" - }, - "x-example": "" + } } }, "required": [ @@ -95113,16 +95014,15 @@ "total": { "type": "integer", "description": "Total number of users that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "users": { "type": "array", "description": "List of users.", "items": { "$ref": "#\/components\/schemas\/user" - }, - "x-example": "" + } } }, "required": [ @@ -95141,16 +95041,15 @@ "total": { "type": "integer", "description": "Total number of sessions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "sessions": { "type": "array", "description": "List of sessions.", "items": { "$ref": "#\/components\/schemas\/session" - }, - "x-example": "" + } } }, "required": [ @@ -95169,16 +95068,15 @@ "total": { "type": "integer", "description": "Total number of identities that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "identities": { "type": "array", "description": "List of identities.", "items": { "$ref": "#\/components\/schemas\/identity" - }, - "x-example": "" + } } }, "required": [ @@ -95197,16 +95095,15 @@ "total": { "type": "integer", "description": "Total number of notifications that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "notifications": { "type": "array", "description": "List of notifications.", "items": { "$ref": "#\/components\/schemas\/notification" - }, - "x-example": "" + } } }, "required": [ @@ -95225,16 +95122,15 @@ "total": { "type": "integer", "description": "Total number of logs that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "logs": { "type": "array", "description": "List of logs.", "items": { "$ref": "#\/components\/schemas\/log" - }, - "x-example": "" + } } }, "required": [ @@ -95253,16 +95149,15 @@ "total": { "type": "integer", "description": "Total number of files that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "files": { "type": "array", "description": "List of files.", "items": { "$ref": "#\/components\/schemas\/file" - }, - "x-example": "" + } } }, "required": [ @@ -95281,16 +95176,15 @@ "total": { "type": "integer", "description": "Total number of buckets that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "buckets": { "type": "array", "description": "List of buckets.", "items": { "$ref": "#\/components\/schemas\/bucket" - }, - "x-example": "" + } } }, "required": [ @@ -95309,16 +95203,15 @@ "total": { "type": "integer", "description": "Total number of tokens that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "tokens": { "type": "array", "description": "List of tokens.", "items": { "$ref": "#\/components\/schemas\/resourceToken" - }, - "x-example": "" + } } }, "required": [ @@ -95337,16 +95230,15 @@ "total": { "type": "integer", "description": "Total number of teams that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "teams": { "type": "array", "description": "List of teams.", "items": { "$ref": "#\/components\/schemas\/team" - }, - "x-example": "" + } } }, "required": [ @@ -95365,16 +95257,15 @@ "total": { "type": "integer", "description": "Total number of memberships that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "memberships": { "type": "array", "description": "List of memberships.", "items": { "$ref": "#\/components\/schemas\/membership" - }, - "x-example": "" + } } }, "required": [ @@ -95393,16 +95284,15 @@ "total": { "type": "integer", "description": "Total number of sites that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "sites": { "type": "array", "description": "List of sites.", "items": { "$ref": "#\/components\/schemas\/site" - }, - "x-example": "" + } } }, "required": [ @@ -95421,16 +95311,15 @@ "total": { "type": "integer", "description": "Total number of templates that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "templates": { "type": "array", "description": "List of templates.", "items": { "$ref": "#\/components\/schemas\/templateSite" - }, - "x-example": "" + } } }, "required": [ @@ -95449,16 +95338,15 @@ "total": { "type": "integer", "description": "Total number of functions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "functions": { "type": "array", "description": "List of functions.", "items": { "$ref": "#\/components\/schemas\/function" - }, - "x-example": "" + } } }, "required": [ @@ -95477,16 +95365,15 @@ "total": { "type": "integer", "description": "Total number of templates that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "templates": { "type": "array", "description": "List of templates.", "items": { "$ref": "#\/components\/schemas\/templateFunction" - }, - "x-example": "" + } } }, "required": [ @@ -95505,16 +95392,15 @@ "total": { "type": "integer", "description": "Total number of installations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "installations": { "type": "array", "description": "List of installations.", "items": { "$ref": "#\/components\/schemas\/installation" - }, - "x-example": "" + } } }, "required": [ @@ -95533,21 +95419,20 @@ "total": { "type": "integer", "description": "Total number of frameworkProviderRepositories that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "frameworkProviderRepositories": { "type": "array", "description": "List of frameworkProviderRepositories.", "items": { "$ref": "#\/components\/schemas\/providerRepositoryFramework" - }, - "x-example": "" + } }, "type": { "type": "string", "description": "Provider repository list type.", - "x-example": "framework" + "example": "framework" } }, "required": [ @@ -95568,21 +95453,20 @@ "total": { "type": "integer", "description": "Total number of runtimeProviderRepositories that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "runtimeProviderRepositories": { "type": "array", "description": "List of runtimeProviderRepositories.", "items": { "$ref": "#\/components\/schemas\/providerRepositoryRuntime" - }, - "x-example": "" + } }, "type": { "type": "string", "description": "Provider repository list type.", - "x-example": "runtime" + "example": "runtime" } }, "required": [ @@ -95603,27 +95487,27 @@ "$id": { "type": "string", "description": "VCS (Version Control System) namespace ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "VCS (Version Control System) namespace display name.", - "x-example": "Appwrite" + "example": "Appwrite" }, "path": { "type": "string", "description": "VCS (Version Control System) namespace path, used to filter repositories by namespace.", - "x-example": "appwrite" + "example": "appwrite" }, "type": { "type": "string", "description": "Namespace type. Either the user's personal namespace or a group\/organization.", - "x-example": "user" + "example": "user" }, "avatarUrl": { "type": "string", "description": "Namespace avatar URL.", - "x-example": "https:\/\/example.com\/avatar.png" + "example": "https:\/\/example.com\/avatar.png" } }, "required": [ @@ -95648,16 +95532,15 @@ "total": { "type": "integer", "description": "Total number of namespaces that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "namespaces": { "type": "array", "description": "List of namespaces.", "items": { "$ref": "#\/components\/schemas\/vcsNamespace" - }, - "x-example": "" + } } }, "required": [ @@ -95676,16 +95559,15 @@ "total": { "type": "integer", "description": "Total number of branches that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "branches": { "type": "array", "description": "List of branches.", "items": { "$ref": "#\/components\/schemas\/branch" - }, - "x-example": "" + } } }, "required": [ @@ -95704,16 +95586,15 @@ "total": { "type": "integer", "description": "Total number of frameworks that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "frameworks": { "type": "array", "description": "List of frameworks.", "items": { "$ref": "#\/components\/schemas\/framework" - }, - "x-example": "" + } } }, "required": [ @@ -95732,16 +95613,15 @@ "total": { "type": "integer", "description": "Total number of runtimes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "runtimes": { "type": "array", "description": "List of runtimes.", "items": { "$ref": "#\/components\/schemas\/runtime" - }, - "x-example": "" + } } }, "required": [ @@ -95760,16 +95640,15 @@ "total": { "type": "integer", "description": "Total number of deployments that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "deployments": { "type": "array", "description": "List of deployments.", "items": { "$ref": "#\/components\/schemas\/deployment" - }, - "x-example": "" + } } }, "required": [ @@ -95788,16 +95667,15 @@ "total": { "type": "integer", "description": "Total number of executions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "executions": { "type": "array", "description": "List of executions.", "items": { "$ref": "#\/components\/schemas\/execution" - }, - "x-example": "" + } } }, "required": [ @@ -95816,16 +95694,15 @@ "total": { "type": "integer", "description": "Total number of projects that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "projects": { "type": "array", "description": "List of projects.", "items": { "$ref": "#\/components\/schemas\/project" - }, - "x-example": "" + } } }, "required": [ @@ -95844,16 +95721,15 @@ "total": { "type": "integer", "description": "Total number of webhooks that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "webhooks": { "type": "array", "description": "List of webhooks.", "items": { "$ref": "#\/components\/schemas\/webhook" - }, - "x-example": "" + } } }, "required": [ @@ -95872,16 +95748,15 @@ "total": { "type": "integer", "description": "Total number of keys that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "keys": { "type": "array", "description": "List of keys.", "items": { "$ref": "#\/components\/schemas\/key" - }, - "x-example": "" + } } }, "required": [ @@ -95900,16 +95775,15 @@ "total": { "type": "integer", "description": "Total number of devKeys that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "devKeys": { "type": "array", "description": "List of devKeys.", "items": { "$ref": "#\/components\/schemas\/devKey" - }, - "x-example": "" + } } }, "required": [ @@ -95928,16 +95802,15 @@ "total": { "type": "integer", "description": "Total number of countries that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "countries": { "type": "array", "description": "List of countries.", "items": { "$ref": "#\/components\/schemas\/country" - }, - "x-example": "" + } } }, "required": [ @@ -95956,16 +95829,15 @@ "total": { "type": "integer", "description": "Total number of continents that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "continents": { "type": "array", "description": "List of continents.", "items": { "$ref": "#\/components\/schemas\/continent" - }, - "x-example": "" + } } }, "required": [ @@ -95984,16 +95856,15 @@ "total": { "type": "integer", "description": "Total number of languages that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "languages": { "type": "array", "description": "List of languages.", "items": { "$ref": "#\/components\/schemas\/language" - }, - "x-example": "" + } } }, "required": [ @@ -96012,16 +95883,15 @@ "total": { "type": "integer", "description": "Total number of currencies that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "currencies": { "type": "array", "description": "List of currencies.", "items": { "$ref": "#\/components\/schemas\/currency" - }, - "x-example": "" + } } }, "required": [ @@ -96040,16 +95910,15 @@ "total": { "type": "integer", "description": "Total number of phones that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "phones": { "type": "array", "description": "List of phones.", "items": { "$ref": "#\/components\/schemas\/phone" - }, - "x-example": "" + } } }, "required": [ @@ -96068,16 +95937,15 @@ "total": { "type": "integer", "description": "Total number of variables that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "variables": { "type": "array", "description": "List of variables.", "items": { "$ref": "#\/components\/schemas\/variable" - }, - "x-example": "" + } } }, "required": [ @@ -96096,16 +95964,15 @@ "total": { "type": "integer", "description": "Total number of mockNumbers that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "mockNumbers": { "type": "array", "description": "List of mockNumbers.", "items": { "$ref": "#\/components\/schemas\/mockNumber" - }, - "x-example": "" + } } }, "required": [ @@ -96124,8 +95991,8 @@ "total": { "type": "integer", "description": "Total number of policies in the given project.", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 }, "policies": { "type": "array", @@ -96198,8 +96065,7 @@ "deny-corporate-email": "#\/components\/schemas\/policyDenyCorporateEmail" } } - }, - "x-example": "" + } } }, "required": [ @@ -96218,16 +96084,15 @@ "total": { "type": "integer", "description": "Total number of templates that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "templates": { "type": "array", "description": "List of templates.", "items": { "$ref": "#\/components\/schemas\/emailTemplate" - }, - "x-example": "" + } } }, "required": [ @@ -96246,16 +96111,15 @@ "total": { "type": "integer", "description": "Total number of rules that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "rules": { "type": "array", "description": "List of rules.", "items": { "$ref": "#\/components\/schemas\/proxyRule" - }, - "x-example": "" + } } }, "required": [ @@ -96274,16 +96138,15 @@ "total": { "type": "integer", "description": "Total number of schedules that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "schedules": { "type": "array", "description": "List of schedules.", "items": { "$ref": "#\/components\/schemas\/schedule" - }, - "x-example": "" + } } }, "required": [ @@ -96304,8 +96167,7 @@ "description": "List of stages.", "items": { "$ref": "#\/components\/schemas\/stage" - }, - "x-example": "" + } } }, "required": [ @@ -96322,16 +96184,15 @@ "total": { "type": "integer", "description": "Total number of localeCodes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "localeCodes": { "type": "array", "description": "List of localeCodes.", "items": { "$ref": "#\/components\/schemas\/localeCode" - }, - "x-example": "" + } } }, "required": [ @@ -96350,16 +96211,15 @@ "total": { "type": "integer", "description": "Total number of providers that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "providers": { "type": "array", "description": "List of providers.", "items": { "$ref": "#\/components\/schemas\/provider" - }, - "x-example": "" + } } }, "required": [ @@ -96378,16 +96238,15 @@ "total": { "type": "integer", "description": "Total number of messages that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "messages": { "type": "array", "description": "List of messages.", "items": { "$ref": "#\/components\/schemas\/message" - }, - "x-example": "" + } } }, "required": [ @@ -96406,16 +96265,15 @@ "total": { "type": "integer", "description": "Total number of topics that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "topics": { "type": "array", "description": "List of topics.", "items": { "$ref": "#\/components\/schemas\/topic" - }, - "x-example": "" + } } }, "required": [ @@ -96434,16 +96292,15 @@ "total": { "type": "integer", "description": "Total number of subscribers that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "subscribers": { "type": "array", "description": "List of subscribers.", "items": { "$ref": "#\/components\/schemas\/subscriber" - }, - "x-example": "" + } } }, "required": [ @@ -96462,16 +96319,15 @@ "total": { "type": "integer", "description": "Total number of targets that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "targets": { "type": "array", "description": "List of targets.", "items": { "$ref": "#\/components\/schemas\/target" - }, - "x-example": "" + } } }, "required": [ @@ -96490,16 +96346,15 @@ "total": { "type": "integer", "description": "Total number of transactions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "transactions": { "type": "array", "description": "List of transactions.", "items": { "$ref": "#\/components\/schemas\/transaction" - }, - "x-example": "" + } } }, "required": [ @@ -96518,16 +96373,15 @@ "total": { "type": "integer", "description": "Total number of migrations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "migrations": { "type": "array", "description": "List of migrations.", "items": { "$ref": "#\/components\/schemas\/migration" - }, - "x-example": "" + } } }, "required": [ @@ -96546,16 +96400,15 @@ "total": { "type": "integer", "description": "Total number of specifications that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "specifications": { "type": "array", "description": "List of specifications.", "items": { "$ref": "#\/components\/schemas\/specification" - }, - "x-example": "" + } } }, "required": [ @@ -96574,16 +96427,15 @@ "total": { "type": "integer", "description": "Total number of contents that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "contents": { "type": "array", "description": "List of contents.", "items": { "$ref": "#\/components\/schemas\/vcsContent" - }, - "x-example": "" + } } }, "required": [ @@ -96602,16 +96454,15 @@ "total": { "type": "integer", "description": "Total number of collections that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "collections": { "type": "array", "description": "List of collections.", "items": { "$ref": "#\/components\/schemas\/vectorsdbCollection" - }, - "x-example": "" + } } }, "required": [ @@ -96630,16 +96481,15 @@ "total": { "type": "integer", "description": "Total number of embeddings that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "embeddings": { "type": "array", "description": "List of embeddings.", "items": { "$ref": "#\/components\/schemas\/embedding" - }, - "x-example": "" + } } }, "required": [ @@ -96658,16 +96508,15 @@ "total": { "type": "integer", "description": "Total number of insights that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "insights": { "type": "array", "description": "List of insights.", "items": { "$ref": "#\/components\/schemas\/insight" - }, - "x-example": "" + } } }, "required": [ @@ -96686,16 +96535,15 @@ "total": { "type": "integer", "description": "Total number of reports that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "reports": { "type": "array", "description": "List of reports.", "items": { "$ref": "#\/components\/schemas\/report" - }, - "x-example": "" + } } }, "required": [ @@ -96714,32 +96562,32 @@ "$id": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Database name.", - "x-example": "My Database" + "example": "My Database" }, "$createdAt": { "type": "string", "description": "Database creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Database update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "enabled": { "type": "boolean", "description": "If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "example": false }, "type": { "type": "string", "description": "Database type.", - "x-example": "legacy", + "example": "legacy", "enum": [ "legacy", "tablesdb", @@ -96754,8 +96602,8 @@ "status": { "type": "string", "description": "Dedicated database lifecycle status. Null when the database has no valid dedicated backing.", - "x-example": "ready", "readOnly": true, + "example": "ready", "enum": [ "provisioning", "ready", @@ -96778,23 +96626,23 @@ "engine": { "type": "string", "description": "Underlying engine of the dedicated backing: postgresql, mysql, or mongodb. A managed product (tablesdb, documentsdb, vectorsdb) reports the engine it runs on, so its type and engine can differ. Null when the database has no dedicated backing.", - "x-example": "postgresql", "readOnly": true, + "example": "postgresql", "nullable": true }, "specification": { "type": "string", "description": "Compute specification identifier of the dedicated backing, e.g. s-2vcpu-2gb. Null when the database has no dedicated backing.", - "x-example": "s-2vcpu-2gb", "readOnly": true, + "example": "s-2vcpu-2gb", "nullable": true }, "replicas": { "type": "integer", "description": "Number of secondary high availability replicas, excluding the primary. Null when backing configuration is unavailable.", - "x-example": 0, "format": "int32", "readOnly": true, + "example": 0, "nullable": true }, "policies": { @@ -96803,7 +96651,7 @@ "items": { "$ref": "#\/components\/schemas\/backupPolicy" }, - "x-example": {}, + "example": [], "nullable": true }, "archives": { @@ -96812,7 +96660,7 @@ "items": { "$ref": "#\/components\/schemas\/backupArchive" }, - "x-example": {}, + "example": [], "nullable": true } }, @@ -96846,13 +96694,13 @@ "model": { "type": "string", "description": "Embedding model used to generate embeddings.", - "x-example": "nomic-embed-text" + "example": "nomic-embed-text" }, "dimension": { "type": "integer", "description": "Number of dimensions for each embedding vector.", - "x-example": 768, - "format": "int32" + "format": "int32", + "example": 768 }, "embedding": { "type": "array", @@ -96861,7 +96709,7 @@ "type": "number", "format": "double" }, - "x-example": [ + "example": [ 0.01, 0.02, 0.03 @@ -96870,7 +96718,7 @@ "error": { "type": "string", "description": "Error message if embedding generation fails. Empty string if no error.", - "x-example": "Error message" + "example": "Error message" } }, "required": [ @@ -96897,17 +96745,17 @@ "$id": { "type": "string", "description": "Collection ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Collection creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Collection update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -96915,29 +96763,29 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Collection name.", - "x-example": "My Collection" + "example": "My Collection" }, "enabled": { "type": "boolean", "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "example": false }, "documentSecurity": { "type": "boolean", "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "example": true }, "attributes": { "type": "array", @@ -97083,7 +96931,7 @@ } } }, - "x-example": {} + "example": [] }, "indexes": { "type": "array", @@ -97091,19 +96939,19 @@ "items": { "$ref": "#\/components\/schemas\/index" }, - "x-example": {} + "example": [] }, "bytesMax": { "type": "integer", "description": "Maximum document size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" + "format": "int32", + "example": 65535 }, "bytesUsed": { "type": "integer", "description": "Currently used document size in bytes based on defined attributes.", - "x-example": 1500, - "format": "int32" + "format": "int32", + "example": 1500 } }, "required": [ @@ -97144,8 +96992,8 @@ "total": { "type": "integer", "description": "Total number of attributes in the given collection.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "attributes": { "type": "array", @@ -97290,8 +97138,7 @@ } } } - }, - "x-example": "" + } } }, "required": [ @@ -97310,17 +97157,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -97333,45 +97180,45 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", "description": "Attribute size.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -97406,17 +97253,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "count" + "example": "count" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "integer" + "example": "integer" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -97429,48 +97276,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "integer", "description": "Minimum value to enforce for new documents.", - "x-example": 1, "format": "int64", + "example": 1, "nullable": true }, "max": { "type": "integer", "description": "Maximum value to enforce for new documents.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true }, "default": { "type": "integer", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": 10, "format": "int32", + "example": 10, "nullable": true } }, @@ -97504,17 +97351,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "count" + "example": "count" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "bigint" + "example": "bigint" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -97527,48 +97374,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "integer", "description": "Minimum value to enforce for new documents.", - "x-example": 1, "format": "int64", + "example": 1, "nullable": true }, "max": { "type": "integer", "description": "Maximum value to enforce for new documents.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true }, "default": { "type": "integer", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true } }, @@ -97602,17 +97449,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "percentageCompleted" + "example": "percentageCompleted" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "double" + "example": "double" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -97625,48 +97472,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "number", "description": "Minimum value to enforce for new documents.", - "x-example": 1.5, "format": "double", + "example": 1.5, "nullable": true }, "max": { "type": "number", "description": "Maximum value to enforce for new documents.", - "x-example": 10.5, "format": "double", + "example": 10.5, "nullable": true }, "default": { "type": "number", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": 2.5, "format": "double", + "example": 2.5, "nullable": true } }, @@ -97700,17 +97547,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "isEnabled" + "example": "isEnabled" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "boolean" + "example": "boolean" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -97723,33 +97570,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, + "example": false, "nullable": true } }, @@ -97781,17 +97628,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "userEmail" + "example": "userEmail" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -97804,38 +97651,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "email" + "example": "email" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default@example.com", + "example": "default@example.com", "nullable": true } }, @@ -97869,17 +97716,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "status" + "example": "status" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -97892,28 +97739,28 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "elements": { "type": "array", @@ -97921,17 +97768,19 @@ "items": { "type": "string" }, - "x-example": "element" + "example": [ + "element" + ] }, "format": { "type": "string", "description": "String format.", - "x-example": "enum" + "example": "enum" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "element", + "example": "element", "nullable": true } }, @@ -97967,17 +97816,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "ipAddress" + "example": "ipAddress" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -97990,38 +97839,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "ip" + "example": "ip" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "192.0.2.0", + "example": "192.0.2.0", "nullable": true } }, @@ -98055,17 +97904,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "githubUrl" + "example": "githubUrl" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -98078,38 +97927,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "url" + "example": "url" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "http:\/\/example.com", + "example": "http:\/\/example.com", "nullable": true } }, @@ -98143,17 +97992,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "birthDay" + "example": "birthDay" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "datetime" + "example": "datetime" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -98166,38 +98015,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "ISO 8601 format.", - "x-example": "datetime" + "example": "datetime" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -98231,17 +98080,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -98254,58 +98103,58 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "relatedCollection": { "type": "string", "description": "The ID of the related collection.", - "x-example": "collection" + "example": "collection" }, "relationType": { "type": "string", "description": "The type of the relationship.", - "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + "example": "oneToOne|oneToMany|manyToOne|manyToMany" }, "twoWay": { "type": "boolean", "description": "Is the relationship two-way?", - "x-example": false + "example": false }, "twoWayKey": { "type": "string", "description": "The key of the two-way relationship.", - "x-example": "string" + "example": "string" }, "onDelete": { "type": "string", "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "example": "restrict|cascade|setNull" }, "side": { "type": "string", "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "example": "parent|child" } }, "required": [ @@ -98347,17 +98196,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -98370,33 +98219,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ + "example": [ 0, 0 ], @@ -98438,17 +98287,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -98461,33 +98310,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ + "example": [ [ 0, 0 @@ -98544,17 +98393,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -98567,33 +98416,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ + "example": [ [ [ 0, @@ -98677,17 +98526,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -98700,45 +98549,45 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", "description": "Attribute size.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -98773,17 +98622,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -98796,39 +98645,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -98861,17 +98710,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -98884,39 +98733,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -98949,17 +98798,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -98972,39 +98821,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -99037,17 +98886,17 @@ "$id": { "type": "string", "description": "Collection ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Collection creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Collection update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -99055,29 +98904,29 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Collection name.", - "x-example": "My Collection" + "example": "My Collection" }, "enabled": { "type": "boolean", "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "example": false }, "documentSecurity": { "type": "boolean", "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "example": true }, "attributes": { "type": "array", @@ -99099,7 +98948,7 @@ } } }, - "x-example": {} + "example": [] }, "indexes": { "type": "array", @@ -99107,25 +98956,25 @@ "items": { "$ref": "#\/components\/schemas\/index" }, - "x-example": {} + "example": [] }, "bytesMax": { "type": "integer", "description": "Maximum document size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" + "format": "int32", + "example": 65535 }, "bytesUsed": { "type": "integer", "description": "Currently used document size in bytes based on defined attributes.", - "x-example": 1500, - "format": "int32" + "format": "int32", + "example": 1500 }, "dimension": { "type": "integer", "description": "Embedding dimension.", - "x-example": 1536, - "format": "int32" + "format": "int32", + "example": 1536 } }, "required": [ @@ -99168,17 +99017,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -99191,28 +99040,28 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -99242,17 +99091,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -99265,34 +99114,34 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", "description": "Vector dimensions.", - "x-example": 1536, - "format": "int32" + "format": "int32", + "example": 1536 } }, "required": [ @@ -99324,17 +99173,17 @@ "$id": { "type": "string", "description": "Table ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Table creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Table update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -99342,29 +99191,29 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Table name.", - "x-example": "My Table" + "example": "My Table" }, "enabled": { "type": "boolean", "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "example": false }, "rowSecurity": { "type": "boolean", "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "example": true }, "columns": { "type": "array", @@ -99510,7 +99359,7 @@ } } }, - "x-example": {} + "example": [] }, "indexes": { "type": "array", @@ -99518,19 +99367,19 @@ "items": { "$ref": "#\/components\/schemas\/columnIndex" }, - "x-example": {} + "example": [] }, "bytesMax": { "type": "integer", "description": "Maximum row size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" + "format": "int32", + "example": 65535 }, "bytesUsed": { "type": "integer", "description": "Currently used row size in bytes based on defined columns.", - "x-example": 1500, - "format": "int32" + "format": "int32", + "example": 1500 } }, "required": [ @@ -99571,8 +99420,8 @@ "total": { "type": "integer", "description": "Total number of columns in the given table.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "columns": { "type": "array", @@ -99717,8 +99566,7 @@ } } } - }, - "x-example": "" + } } }, "required": [ @@ -99737,17 +99585,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -99760,45 +99608,45 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", "description": "Column size.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -99833,17 +99681,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "count" + "example": "count" }, "type": { "type": "string", "description": "Column type.", - "x-example": "integer" + "example": "integer" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -99856,48 +99704,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "integer", "description": "Minimum value to enforce for new documents.", - "x-example": 1, "format": "int64", + "example": 1, "nullable": true }, "max": { "type": "integer", "description": "Maximum value to enforce for new documents.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true }, "default": { "type": "integer", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 10, "format": "int32", + "example": 10, "nullable": true } }, @@ -99931,17 +99779,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "count" + "example": "count" }, "type": { "type": "string", "description": "Column type.", - "x-example": "bigint" + "example": "bigint" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -99954,48 +99802,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "integer", "description": "Minimum value to enforce for new documents.", - "x-example": 1, "format": "int64", + "example": 1, "nullable": true }, "max": { "type": "integer", "description": "Maximum value to enforce for new documents.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true }, "default": { "type": "integer", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true } }, @@ -100029,17 +99877,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "percentageCompleted" + "example": "percentageCompleted" }, "type": { "type": "string", "description": "Column type.", - "x-example": "double" + "example": "double" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100052,48 +99900,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "number", "description": "Minimum value to enforce for new documents.", - "x-example": 1.5, "format": "double", + "example": 1.5, "nullable": true }, "max": { "type": "number", "description": "Maximum value to enforce for new documents.", - "x-example": 10.5, "format": "double", + "example": 10.5, "nullable": true }, "default": { "type": "number", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 2.5, "format": "double", + "example": 2.5, "nullable": true } }, @@ -100127,17 +99975,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "isEnabled" + "example": "isEnabled" }, "type": { "type": "string", "description": "Column type.", - "x-example": "boolean" + "example": "boolean" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100150,33 +99998,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "boolean", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": false, + "example": false, "nullable": true } }, @@ -100208,17 +100056,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "userEmail" + "example": "userEmail" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100231,38 +100079,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "email" + "example": "email" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default@example.com", + "example": "default@example.com", "nullable": true } }, @@ -100296,17 +100144,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "status" + "example": "status" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100319,28 +100167,28 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "elements": { "type": "array", @@ -100348,17 +100196,19 @@ "items": { "type": "string" }, - "x-example": "element" + "example": [ + "element" + ] }, "format": { "type": "string", "description": "String format.", - "x-example": "enum" + "example": "enum" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "element", + "example": "element", "nullable": true } }, @@ -100394,17 +100244,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "ipAddress" + "example": "ipAddress" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100417,38 +100267,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "ip" + "example": "ip" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "192.0.2.0", + "example": "192.0.2.0", "nullable": true } }, @@ -100482,17 +100332,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "githubUrl" + "example": "githubUrl" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100505,38 +100355,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "url" + "example": "url" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "nullable": true } }, @@ -100570,17 +100420,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "birthDay" + "example": "birthDay" }, "type": { "type": "string", "description": "Column type.", - "x-example": "datetime" + "example": "datetime" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100593,38 +100443,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "ISO 8601 format.", - "x-example": "datetime" + "example": "datetime" }, "default": { "type": "string", "description": "Default value for column when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -100658,17 +100508,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100681,58 +100531,58 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "relatedTable": { "type": "string", "description": "The ID of the related table.", - "x-example": "table" + "example": "table" }, "relationType": { "type": "string", "description": "The type of the relationship.", - "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + "example": "oneToOne|oneToMany|manyToOne|manyToMany" }, "twoWay": { "type": "boolean", "description": "Is the relationship two-way?", - "x-example": false + "example": false }, "twoWayKey": { "type": "string", "description": "The key of the two-way relationship.", - "x-example": "string" + "example": "string" }, "onDelete": { "type": "string", "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "example": "restrict|cascade|setNull" }, "side": { "type": "string", "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "example": "parent|child" } }, "required": [ @@ -100774,17 +100624,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100797,33 +100647,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ + "example": [ 0, 0 ], @@ -100865,17 +100715,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100888,33 +100738,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ + "example": [ [ 0, 0 @@ -100971,17 +100821,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -100994,33 +100844,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ + "example": [ [ [ 0, @@ -101104,17 +100954,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -101127,45 +100977,45 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", "description": "Column size.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -101200,17 +101050,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -101223,39 +101073,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -101288,17 +101138,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -101311,39 +101161,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -101376,17 +101226,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -101399,39 +101249,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -101464,32 +101314,32 @@ "$id": { "type": "string", "description": "Index ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Index creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Index update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "key": { "type": "string", "description": "Index key.", - "x-example": "index1" + "example": "index1" }, "type": { "type": "string", "description": "Index type.", - "x-example": "primary" + "example": "primary" }, "status": { "type": "string", "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -101501,7 +101351,7 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "example": "string" }, "attributes": { "type": "array", @@ -101509,7 +101359,7 @@ "items": { "type": "string" }, - "x-example": [] + "example": [] }, "lengths": { "type": "array", @@ -101518,7 +101368,7 @@ "type": "integer", "format": "int32" }, - "x-example": [] + "example": [] }, "orders": { "type": "array", @@ -101526,7 +101376,7 @@ "items": { "type": "string" }, - "x-example": [], + "example": [], "nullable": true } }, @@ -101561,37 +101411,37 @@ "$id": { "type": "string", "description": "Index ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Index creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Index update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "key": { "type": "string", "description": "Index Key.", - "x-example": "index1" + "example": "index1" }, "type": { "type": "string", "description": "Index type.", - "x-example": "primary" + "example": "primary" }, "status": { "type": "string", "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available" + "example": "available" }, "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "example": "string" }, "columns": { "type": "array", @@ -101599,7 +101449,7 @@ "items": { "type": "string" }, - "x-example": [] + "example": [] }, "lengths": { "type": "array", @@ -101608,7 +101458,7 @@ "type": "integer", "format": "int32" }, - "x-example": [] + "example": [] }, "orders": { "type": "array", @@ -101616,7 +101466,7 @@ "items": { "type": "string" }, - "x-example": [], + "example": [], "nullable": true } }, @@ -101651,35 +101501,35 @@ "$id": { "type": "string", "description": "Row ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$sequence": { "type": "string", "description": "Row sequence ID.", - "x-example": "1", - "readOnly": true + "readOnly": true, + "example": "1" }, "$tableId": { "type": "string", "description": "Table ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$createdAt": { "type": "string", "description": "Row creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Row update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -101687,7 +101537,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] } @@ -101721,35 +101571,35 @@ "$id": { "type": "string", "description": "Document ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$sequence": { "type": "string", "description": "Document sequence ID.", - "x-example": "1", - "readOnly": true + "readOnly": true, + "example": "1" }, "$collectionId": { "type": "string", "description": "Collection ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$createdAt": { "type": "string", "description": "Document creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Document update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -101757,7 +101607,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] } @@ -101796,17 +101646,17 @@ "$id": { "type": "string", "description": "Presence ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Presence creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Presence update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -101814,37 +101664,37 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "userId": { "type": "string", "description": "User ID.", - "x-example": "674af8f3e12a5f9ac0be" + "example": "674af8f3e12a5f9ac0be" }, "status": { "type": "string", "description": "Presence status.", - "x-example": "online", + "example": "online", "nullable": true }, "source": { "type": "string", "description": "Presence source.", - "x-example": "HTTP" + "example": "HTTP" }, "expiresAt": { "type": "string", "description": "Presence expiry date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "metadata": { "type": "object", "additionalProperties": true, "description": "Presence metadata.", - "x-example": { + "example": { "key": "value" } } @@ -101880,112 +101730,112 @@ "event": { "type": "string", "description": "Event name.", - "x-example": "account.sessions.create" + "example": "account.sessions.create" }, "userId": { "type": "string", "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "userEmail": { "type": "string", "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "userName": { "type": "string", "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "John Doe" + "example": "John Doe" }, "mode": { "type": "string", "description": "API mode when event triggered.", - "x-example": "admin" + "example": "admin" }, "userType": { "type": "string", "description": "User type who triggered the audit log. Possible values: user, admin, guest, hidden, keyProject, keyAccount, keyOrganization.", - "x-example": "user" + "example": "user" }, "ip": { "type": "string", "description": "IP session in use when the session was created.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "time": { "type": "string", "description": "Log creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "osCode": { "type": "string", "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "example": "Mac" }, "osName": { "type": "string", "description": "Operating system name.", - "x-example": "Mac" + "example": "Mac" }, "osVersion": { "type": "string", "description": "Operating system version.", - "x-example": "Mac" + "example": "Mac" }, "clientType": { "type": "string", "description": "Client type.", - "x-example": "browser" + "example": "browser" }, "clientCode": { "type": "string", "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "example": "CM" }, "clientName": { "type": "string", "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "example": "Chrome Mobile iOS" }, "clientVersion": { "type": "string", "description": "Client version.", - "x-example": "84.0" + "example": "84.0" }, "clientEngine": { "type": "string", "description": "Client engine name.", - "x-example": "WebKit" + "example": "WebKit" }, "clientEngineVersion": { "type": "string", "description": "Client engine name.", - "x-example": "605.1.15" + "example": "605.1.15" }, "deviceName": { "type": "string", "description": "Device name.", - "x-example": "smartphone" + "example": "smartphone" }, "deviceBrand": { "type": "string", "description": "Device brand name.", - "x-example": "Google" + "example": "Google" }, "deviceModel": { "type": "string", "description": "Device model name.", - "x-example": "Nexus 5" + "example": "Nexus 5" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" }, "countryName": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" } }, "required": [ @@ -102044,39 +101894,39 @@ "$id": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "User creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "User update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "User name.", - "x-example": "John Doe" + "example": "John Doe" }, "password": { "type": "string", "description": "Hashed user password.", - "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", "nullable": true }, "hash": { "type": "string", "description": "Password hashing algorithm.", - "x-example": "argon2", + "example": "argon2", "nullable": true }, "hashOptions": { "type": "object", "description": "Password hashing algorithm configuration.", - "x-example": {}, + "example": {}, "allOf": [ { "oneOf": [ @@ -102121,12 +101971,12 @@ "registration": { "type": "string", "description": "User registration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "status": { "type": "boolean", "description": "User status. Pass `true` for enabled and `false` for disabled.", - "x-example": true + "example": true }, "labels": { "type": "array", @@ -102134,74 +101984,74 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "vip" ] }, "passwordUpdate": { "type": "string", "description": "Password update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "email": { "type": "string", "description": "User email address.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "phone": { "type": "string", "description": "User phone number in E.164 format.", - "x-example": "+4930901820" + "example": "+4930901820" }, "emailVerification": { "type": "boolean", "description": "Email verification status.", - "x-example": true + "example": true }, "emailCanonical": { "type": "string", "description": "Canonical form of the user email address.", - "x-example": "john@appwrite.io", + "example": "john@appwrite.io", "nullable": true }, "emailIsFree": { "type": "boolean", "description": "Whether the user email is from a free email provider.", - "x-example": true, + "example": true, "nullable": true }, "emailIsDisposable": { "type": "boolean", "description": "Whether the user email is from a disposable email provider.", - "x-example": false, + "example": false, "nullable": true }, "emailIsCorporate": { "type": "boolean", "description": "Whether the user email is from a corporate domain.", - "x-example": true, + "example": true, "nullable": true }, "emailIsCanonical": { "type": "boolean", "description": "Whether the user email is in its canonical form.", - "x-example": true, + "example": true, "nullable": true }, "phoneVerification": { "type": "boolean", "description": "Phone verification status.", - "x-example": true + "example": true }, "mfa": { "type": "boolean", "description": "Multi factor authentication status.", - "x-example": true + "example": true }, "prefs": { "type": "object", "description": "User preferences as a key-value object", - "x-example": { + "example": { "theme": "pink", "timezone": "UTC" }, @@ -102217,23 +102067,23 @@ "items": { "$ref": "#\/components\/schemas\/target" }, - "x-example": [] + "example": [] }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "impersonator": { "type": "boolean", "description": "Whether the user can impersonate other users.", - "x-example": false, + "example": false, "nullable": true }, "impersonatorUserId": { "type": "string", "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", - "x-example": "5e5ea5c16897e", + "example": "5e5ea5c16897e", "nullable": true } }, @@ -102296,7 +102146,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "md5" + "example": "md5" } }, "required": [ @@ -102313,7 +102163,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "sha" + "example": "sha" } }, "required": [ @@ -102330,7 +102180,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "phpass" + "example": "phpass" } }, "required": [ @@ -102347,7 +102197,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "bcrypt" + "example": "bcrypt" } }, "required": [ @@ -102364,31 +102214,31 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "scrypt" + "example": "scrypt" }, "costCpu": { "type": "integer", "description": "CPU complexity of computed hash.", - "x-example": 8, - "format": "int32" + "format": "int32", + "example": 8 }, "costMemory": { "type": "integer", "description": "Memory complexity of computed hash.", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "costParallel": { "type": "integer", "description": "Parallelization of computed hash.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "length": { "type": "integer", "description": "Length used to compute hash.", - "x-example": 64, - "format": "int32" + "format": "int32", + "example": 64 } }, "required": [ @@ -102413,22 +102263,22 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "scryptMod" + "example": "scryptMod" }, "salt": { "type": "string", "description": "Salt used to compute hash.", - "x-example": "UxLMreBr6tYyjQ==" + "example": "UxLMreBr6tYyjQ==" }, "saltSeparator": { "type": "string", "description": "Separator used to compute hash.", - "x-example": "Bw==" + "example": "Bw==" }, "signerKey": { "type": "string", "description": "Key used to compute hash.", - "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + "example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" } }, "required": [ @@ -102451,25 +102301,25 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "argon2" + "example": "argon2" }, "memoryCost": { "type": "integer", "description": "Memory used to compute hash.", - "x-example": 65536, - "format": "int32" + "format": "int32", + "example": 65536 }, "timeCost": { "type": "integer", "description": "Amount of time consumed to compute hash", - "x-example": 4, - "format": "int32" + "format": "int32", + "example": 4 }, "threads": { "type": "integer", "description": "Number of threads used to compute hash.", - "x-example": 3, - "format": "int32" + "format": "int32", + "example": 3 } }, "required": [ @@ -102502,132 +102352,132 @@ "$id": { "type": "string", "description": "Session ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Session creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Session update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "expire": { "type": "string", "description": "Session expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "provider": { "type": "string", "description": "Session Provider.", - "x-example": "email" + "example": "email" }, "providerUid": { "type": "string", "description": "Session Provider User ID.", - "x-example": "user@example.com" + "example": "user@example.com" }, "providerAccessToken": { "type": "string", "description": "Session Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, "providerAccessTokenExpiry": { "type": "string", "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "providerRefreshToken": { "type": "string", "description": "Session Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, "ip": { "type": "string", "description": "IP in use when the session was created.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "osCode": { "type": "string", "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "example": "Mac" }, "osName": { "type": "string", "description": "Operating system name.", - "x-example": "Mac" + "example": "Mac" }, "osVersion": { "type": "string", "description": "Operating system version.", - "x-example": "Mac" + "example": "Mac" }, "clientType": { "type": "string", "description": "Client type.", - "x-example": "browser" + "example": "browser" }, "clientCode": { "type": "string", "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "example": "CM" }, "clientName": { "type": "string", "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "example": "Chrome Mobile iOS" }, "clientVersion": { "type": "string", "description": "Client version.", - "x-example": "84.0" + "example": "84.0" }, "clientEngine": { "type": "string", "description": "Client engine name.", - "x-example": "WebKit" + "example": "WebKit" }, "clientEngineVersion": { "type": "string", "description": "Client engine name.", - "x-example": "605.1.15" + "example": "605.1.15" }, "deviceName": { "type": "string", "description": "Device name.", - "x-example": "smartphone" + "example": "smartphone" }, "deviceBrand": { "type": "string", "description": "Device brand name.", - "x-example": "Google" + "example": "Google" }, "deviceModel": { "type": "string", "description": "Device model name.", - "x-example": "Nexus 5" + "example": "Nexus 5" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" }, "countryName": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" }, "current": { "type": "boolean", "description": "Returns true if this the current user session.", - "x-example": true + "example": true }, "factors": { "type": "array", @@ -102635,19 +102485,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "email" ] }, "secret": { "type": "string", "description": "Secret used to authenticate the user. Only included if the request was made with an API key", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "mfaUpdatedAt": { "type": "string", "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -102722,52 +102572,52 @@ "$id": { "type": "string", "description": "Identity ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Identity creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Identity update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "provider": { "type": "string", "description": "Identity Provider.", - "x-example": "email" + "example": "email" }, "providerUid": { "type": "string", "description": "ID of the User in the Identity Provider.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "providerEmail": { "type": "string", "description": "Email of the User in the Identity Provider.", - "x-example": "user@example.com" + "example": "user@example.com" }, "providerAccessToken": { "type": "string", "description": "Identity Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, "providerAccessTokenExpiry": { "type": "string", "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "providerRefreshToken": { "type": "string", "description": "Identity Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" } }, "required": [ @@ -102802,86 +102652,86 @@ "$id": { "type": "string", "description": "Notification ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Notification creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Notification update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "messageId": { "type": "string", "description": "Stable message ID used for dedup.", - "x-example": "session.create", + "example": "session.create", "nullable": true }, "type": { "type": "string", "description": "Notification type: info, warning, error.", - "x-example": "info" + "example": "info" }, "channel": { "type": "string", "description": "Channel: email, sms, push, console, webhook.", - "x-example": "email" + "example": "email" }, "resourceType": { "type": "string", "description": "Resource type this notification is addressed to.", - "x-example": "users" + "example": "users" }, "resourceId": { "type": "string", "description": "Resource ID this notification is addressed to.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "parentResourceType": { "type": "string", "description": "Parent resource type for the notification.", - "x-example": "projects" + "example": "projects" }, "parentResourceId": { "type": "string", "description": "Parent resource ID for the notification.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "projectId": { "type": "string", "description": "Project the notification pertains to.", - "x-example": "5e5bb8c16897e", + "example": "5e5bb8c16897e", "nullable": true }, "title": { "type": "string", "description": "Notification title.", - "x-example": "New sign-in detected" + "example": "New sign-in detected" }, "body": { "type": "string", "description": "Notification body.", - "x-example": "A new device signed in to your account." + "example": "A new device signed in to your account." }, "read": { "type": "boolean", "description": "Whether the notification has been read.", - "x-example": false, + "example": false, "nullable": true }, "firstSeen": { "type": "string", "description": "First time the notification was viewed from a notification logo.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "lastSeen": { "type": "string", "description": "Most recent time the notification was viewed from a notification logo.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -102924,32 +102774,32 @@ "$id": { "type": "string", "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8" }, "secret": { "type": "string", "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "example": "" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "phrase": { "type": "string", "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", - "x-example": "Golden Fox" + "example": "Golden Fox" } }, "required": [ @@ -102976,7 +102826,7 @@ "jwt": { "type": "string", "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" } }, "required": [ @@ -102993,104 +102843,104 @@ "ip": { "type": "string", "description": "User IP address.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "countryCode": { "type": "string", "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", - "x-example": "US" + "example": "US" }, "country": { "type": "string", "description": "Country name. This field support localization.", - "x-example": "United States" + "example": "United States" }, "continentCode": { "type": "string", "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", - "x-example": "NA" + "example": "NA" }, "continent": { "type": "string", "description": "Continent name. This field support localization.", - "x-example": "North America" + "example": "North America" }, "eu": { "type": "boolean", "description": "True if country is part of the European Union.", - "x-example": false + "example": false }, "currency": { "type": "string", "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", - "x-example": "USD" + "example": "USD" }, "city": { "type": "string", "description": "City", - "x-example": "Kathmandu", + "example": "Kathmandu", "nullable": true }, "timeZone": { "type": "string", "description": "Name of timezone", - "x-example": "Asia\/Kathmandu", + "example": "Asia\/Kathmandu", "nullable": true }, "postalCode": { "type": "string", "description": "Postal code", - "x-example": "44600", + "example": "44600", "nullable": true }, "latitude": { "type": "number", "description": "Latitude", - "x-example": "82.345", "format": "double", + "example": 82.345, "nullable": true }, "longitude": { "type": "number", "description": "Longitude", - "x-example": "82.345", "format": "double", + "example": 82.345, "nullable": true }, "autonomousSystemNumber": { "type": "string", "description": "Autonomous System Number (ASN) of the IP", - "x-example": "15169", + "example": "15169", "nullable": true }, "autonomousSystemOrganization": { "type": "string", "description": "Organization that owns the ASN", - "x-example": "GOOGLE", + "example": "GOOGLE", "nullable": true }, "isp": { "type": "string", "description": "Internet service provider of the IP", - "x-example": "Google", + "example": "Google", "nullable": true }, "connectionType": { "type": "string", "description": "Connection type of the IP (e.g. cable, cellular, corporate)", - "x-example": "cable", + "example": "cable", "nullable": true }, "connectionUsageType": { "type": "string", "description": "User type classification of the IP (e.g. residential, business, hosting)", - "x-example": "residential", + "example": "residential", "nullable": true }, "connectionOrganization": { "type": "string", "description": "Registered organization of the IP", - "x-example": "Google LLC", + "example": "Google LLC", "nullable": true } }, @@ -103131,12 +102981,12 @@ "code": { "type": "string", "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", - "x-example": "en-us" + "example": "en-us" }, "name": { "type": "string", "description": "Locale name", - "x-example": "US" + "example": "US" } }, "required": [ @@ -103155,22 +103005,22 @@ "$id": { "type": "string", "description": "File ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "bucketId": { "type": "string", "description": "Bucket ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "File creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "File update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -103178,68 +103028,68 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "name": { "type": "string", "description": "File name.", - "x-example": "Pink.png" + "example": "Pink.png" }, "folder": { "type": "string", "description": "Virtual folder containing the file, with a trailing slash. Empty for the bucket root.", - "x-example": "photos\/2026\/" + "example": "photos\/2026\/" }, "key": { "type": "string", "description": "Full virtual path of the file: the folder followed by the file name.", - "x-example": "photos\/2026\/Pink.png" + "example": "photos\/2026\/Pink.png" }, "signature": { "type": "string", "description": "File MD5 signature.", - "x-example": "5d529fd02b544198ae075bd57c1762bb" + "example": "5d529fd02b544198ae075bd57c1762bb" }, "mimeType": { "type": "string", "description": "File mime type.", - "x-example": "image\/png" + "example": "image\/png" }, "sizeOriginal": { "type": "integer", "description": "File original size in bytes.", - "x-example": 17890, - "format": "int32" + "format": "int32", + "example": 17890 }, "sizeActual": { "type": "integer", "description": "File actual stored size in bytes after compression and\/or encryption.", - "x-example": 12345, - "format": "int32" + "format": "int32", + "example": 12345 }, "chunksTotal": { "type": "integer", "description": "Total number of chunks available", - "x-example": 17890, - "format": "int32" + "format": "int32", + "example": 17890 }, "chunksUploaded": { "type": "integer", "description": "Total number of chunks uploaded", - "x-example": 17890, - "format": "int32" + "format": "int32", + "example": 17890 }, "encryption": { "type": "boolean", "description": "Whether file contents are encrypted at rest.", - "x-example": true + "example": true }, "compression": { "type": "string", "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" + "example": "gzip" } }, "required": [ @@ -103288,17 +103138,17 @@ "$id": { "type": "string", "description": "Bucket ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Bucket creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Bucket update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -103306,30 +103156,30 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "fileSecurity": { "type": "boolean", "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "example": true }, "name": { "type": "string", "description": "Bucket name.", - "x-example": "Documents" + "example": "Documents" }, "enabled": { "type": "boolean", "description": "Bucket enabled.", - "x-example": false + "example": false }, "maximumFileSize": { "type": "integer", "description": "Maximum file size supported.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "allowedFileExtensions": { "type": "array", @@ -103337,7 +103187,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "jpg", "png" ] @@ -103345,28 +103195,28 @@ "compression": { "type": "string", "description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" + "example": "gzip" }, "encryption": { "type": "boolean", "description": "Bucket is encrypted.", - "x-example": false + "example": false }, "antivirus": { "type": "boolean", "description": "Virus scanning is enabled.", - "x-example": false + "example": false }, "transformations": { "type": "boolean", "description": "Image transformations are enabled.", - "x-example": false + "example": false }, "totalSize": { "type": "integer", "description": "Total size of this bucket in bytes.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 } }, "required": [ @@ -103414,37 +103264,37 @@ "$id": { "type": "string", "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "resourceId": { "type": "string", "description": "Resource ID.", - "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" + "example": "5e5ea5c168bb8:5e5ea5c168bb8" }, "resourceType": { "type": "string", "description": "Resource type.", - "x-example": "files" + "example": "files" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "secret": { "type": "string", "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -103473,33 +103323,33 @@ "$id": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Team creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Team update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Team name.", - "x-example": "VIP" + "example": "VIP" }, "total": { "type": "integer", "description": "Total number of team members.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "prefs": { "type": "object", "description": "Team preferences as a key-value object", - "x-example": { + "example": { "theme": "pink", "timezone": "UTC" }, @@ -103537,72 +103387,72 @@ "$id": { "type": "string", "description": "Membership ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Membership creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Membership update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userName": { "type": "string", "description": "User name. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "John Doe" + "example": "John Doe" }, "userEmail": { "type": "string", "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "userPhone": { "type": "string", "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "+1 555 555 5555" + "example": "+1 555 555 5555" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "teamName": { "type": "string", "description": "Team name.", - "x-example": "VIP" + "example": "VIP" }, "invited": { "type": "string", "description": "Date, the user has been invited to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "joined": { "type": "string", "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "confirm": { "type": "boolean", "description": "User confirmation status, true if the user has joined the team or false otherwise.", - "x-example": false + "example": false }, "mfa": { "type": "boolean", "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", - "x-example": false + "example": false }, "userAccessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "roles": { "type": "array", @@ -103610,7 +103460,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "owner" ] } @@ -103659,83 +103509,83 @@ "$id": { "type": "string", "description": "Site ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Site creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Site update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Site name.", - "x-example": "My Site" + "example": "My Site" }, "enabled": { "type": "boolean", "description": "Site enabled.", - "x-example": false + "example": false }, "live": { "type": "boolean", "description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.", - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "x-example": false + "example": false }, "framework": { "type": "string", "description": "Site framework.", - "x-example": "react" + "example": "react" }, "deploymentRetention": { "type": "integer", "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "deploymentId": { "type": "string", "description": "Site's active deployment ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "deploymentCreatedAt": { "type": "string", "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "deploymentScreenshotLight": { "type": "string", "description": "Screenshot of active deployment with light theme preference file ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "deploymentScreenshotDark": { "type": "string", "description": "Screenshot of active deployment with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "latestDeploymentId": { "type": "string", "description": "Site's latest deployment ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "latestDeploymentCreatedAt": { "type": "string", "description": "Latest deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "latestDeploymentStatus": { "type": "string", "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" + "example": "ready" }, "scopes": { "type": "array", @@ -103743,7 +103593,9 @@ "items": { "type": "string" }, - "x-example": "users.read" + "example": [ + "users.read" + ] }, "vars": { "type": "array", @@ -103751,58 +103603,58 @@ "items": { "$ref": "#\/components\/schemas\/variable" }, - "x-example": [] + "example": [] }, "timeout": { "type": "integer", "description": "Site request timeout in seconds.", - "x-example": 300, - "format": "int32" + "format": "int32", + "example": 300 }, "installCommand": { "type": "string", "description": "The install command used to install the site dependencies.", - "x-example": "npm install" + "example": "npm install" }, "buildCommand": { "type": "string", "description": "The build command used to build the site.", - "x-example": "npm run build" + "example": "npm run build" }, "startCommand": { "type": "string", "description": "Custom command to use when starting site runtime.", - "x-example": "node custom-server.mjs" + "example": "node custom-server.mjs" }, "outputDirectory": { "type": "string", "description": "The directory where the site build output is located.", - "x-example": "build" + "example": "build" }, "installationId": { "type": "string", "description": "Site VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "example": "6m40at4ejk5h2u9s1hboo" }, "providerRepositoryId": { "type": "string", "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "example": "appwrite" }, "providerBranch": { "type": "string", "description": "VCS (Version Control System) branch name", - "x-example": "main" + "example": "main" }, "providerRootDirectory": { "type": "string", "description": "Path to site in VCS (Version Control System) repository", - "x-example": "sites\/helloWorld" + "example": "sites\/helloWorld" }, "providerSilentMode": { "type": "boolean", "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "example": false }, "providerBranches": { "type": "array", @@ -103810,7 +103662,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "main", "feat\/*" ] @@ -103821,7 +103673,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "src\/**", "!docs\/**" ] @@ -103829,27 +103681,27 @@ "buildSpecification": { "type": "string", "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb" }, "runtimeSpecification": { "type": "string", "description": "Machine specification for SSR executions.", - "x-example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb" }, "buildRuntime": { "type": "string", "description": "Site build runtime.", - "x-example": "node-22" + "example": "node-22" }, "adapter": { "type": "string", "description": "Site framework adapter.", - "x-example": "static" + "example": "static" }, "fallbackFile": { "type": "string", "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "example": "index.html" } }, "required": [ @@ -103940,32 +103792,32 @@ "key": { "type": "string", "description": "Site Template ID.", - "x-example": "starter" + "example": "starter" }, "name": { "type": "string", "description": "Site Template Name.", - "x-example": "Starter site" + "example": "Starter site" }, "tagline": { "type": "string", "description": "Short description of template", - "x-example": "Minimal web app integrating with Appwrite." + "example": "Minimal web app integrating with Appwrite." }, "demoUrl": { "type": "string", "description": "URL hosting a template demo.", - "x-example": "https:\/\/nextjs-starter.appwrite.network\/" + "example": "https:\/\/nextjs-starter.appwrite.network\/" }, "screenshotDark": { "type": "string", "description": "File URL with preview screenshot in dark theme preference.", - "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png" + "example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png" }, "screenshotLight": { "type": "string", "description": "File URL with preview screenshot in light theme preference.", - "x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png" + "example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png" }, "useCases": { "type": "array", @@ -103973,7 +103825,9 @@ "items": { "type": "string" }, - "x-example": "Starter" + "example": [ + "Starter" + ] }, "frameworks": { "type": "array", @@ -103981,27 +103835,27 @@ "items": { "$ref": "#\/components\/schemas\/templateFramework" }, - "x-example": [] + "example": [] }, "vcsProvider": { "type": "string", "description": "VCS (Version Control System) Provider.", - "x-example": "github" + "example": "github" }, "providerRepositoryId": { "type": "string", "description": "VCS (Version Control System) Repository ID", - "x-example": "templates" + "example": "templates" }, "providerOwner": { "type": "string", "description": "VCS (Version Control System) Owner.", - "x-example": "appwrite" + "example": "appwrite" }, "providerVersion": { "type": "string", "description": "VCS (Version Control System) branch version (tag).", - "x-example": "main" + "example": "main" }, "variables": { "type": "array", @@ -104009,7 +103863,7 @@ "items": { "$ref": "#\/components\/schemas\/templateVariable" }, - "x-example": [] + "example": [] } }, "required": [ @@ -104050,47 +103904,47 @@ "key": { "type": "string", "description": "Parent framework key.", - "x-example": "sveltekit" + "example": "sveltekit" }, "name": { "type": "string", "description": "Framework Name.", - "x-example": "SvelteKit" + "example": "SvelteKit" }, "installCommand": { "type": "string", "description": "The install command used to install the dependencies.", - "x-example": "npm install" + "example": "npm install" }, "buildCommand": { "type": "string", "description": "The build command used to build the deployment.", - "x-example": "npm run build" + "example": "npm run build" }, "outputDirectory": { "type": "string", "description": "The output directory to store the build output.", - "x-example": ".\/build" + "example": ".\/build" }, "providerRootDirectory": { "type": "string", "description": "Path to site in VCS (Version Control System) repository", - "x-example": ".\/svelte-kit\/starter" + "example": ".\/svelte-kit\/starter" }, "buildRuntime": { "type": "string", "description": "Runtime used during build step of template.", - "x-example": "node-22" + "example": "node-22" }, "adapter": { "type": "string", "description": "Site framework runtime", - "x-example": "ssr" + "example": "ssr" }, "fallbackFile": { "type": "string", "description": "Fallback file for SPA. Only relevant for static serve runtime.", - "x-example": "index.html" + "example": "index.html" } }, "required": [ @@ -104123,17 +103977,17 @@ "$id": { "type": "string", "description": "Function ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Function creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Function update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "execute": { "type": "array", @@ -104141,63 +103995,65 @@ "items": { "type": "string" }, - "x-example": "users" + "example": [ + "users" + ] }, "name": { "type": "string", "description": "Function name.", - "x-example": "My Function" + "example": "My Function" }, "enabled": { "type": "boolean", "description": "Function enabled.", - "x-example": false + "example": false }, "live": { "type": "boolean", "description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.", - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", - "x-example": false + "example": false }, "runtime": { "type": "string", "description": "Function execution and build runtime.", - "x-example": "python-3.8" + "example": "python-3.8" }, "deploymentRetention": { "type": "integer", "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "deploymentId": { "type": "string", "description": "Function's active deployment ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "deploymentCreatedAt": { "type": "string", "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "latestDeploymentId": { "type": "string", "description": "Function's latest deployment ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "latestDeploymentCreatedAt": { "type": "string", "description": "Latest deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "latestDeploymentStatus": { "type": "string", "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" + "example": "ready" }, "scopes": { "type": "array", @@ -104205,7 +104061,9 @@ "items": { "type": "string" }, - "x-example": "users.read" + "example": [ + "users.read" + ] }, "vars": { "type": "array", @@ -104213,7 +104071,7 @@ "items": { "$ref": "#\/components\/schemas\/variable" }, - "x-example": [] + "example": [] }, "events": { "type": "array", @@ -104221,58 +104079,60 @@ "items": { "type": "string" }, - "x-example": "account.create" + "example": [ + "account.create" + ] }, "schedule": { "type": "string", "description": "Function execution schedule in CRON format.", - "x-example": "5 4 * * *" + "example": "5 4 * * *" }, "timeout": { "type": "integer", "description": "Function execution timeout in seconds.", - "x-example": 300, - "format": "int32" + "format": "int32", + "example": 300 }, "entrypoint": { "type": "string", "description": "The entrypoint file used to execute the deployment.", - "x-example": "index.js" + "example": "index.js" }, "commands": { "type": "string", "description": "The build command used to build the deployment.", - "x-example": "npm install" + "example": "npm install" }, "version": { "type": "string", "description": "Version of Open Runtimes used for the function.", - "x-example": "v2" + "example": "v2" }, "installationId": { "type": "string", "description": "Function VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "example": "6m40at4ejk5h2u9s1hboo" }, "providerRepositoryId": { "type": "string", "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "example": "appwrite" }, "providerBranch": { "type": "string", "description": "VCS (Version Control System) branch name", - "x-example": "main" + "example": "main" }, "providerRootDirectory": { "type": "string", "description": "Path to function in VCS (Version Control System) repository", - "x-example": "functions\/helloWorld" + "example": "functions\/helloWorld" }, "providerSilentMode": { "type": "boolean", "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "example": false }, "providerBranches": { "type": "array", @@ -104280,7 +104140,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "main", "feat\/*" ] @@ -104291,7 +104151,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "src\/**", "!docs\/**" ] @@ -104299,12 +104159,12 @@ "buildSpecification": { "type": "string", "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb" }, "runtimeSpecification": { "type": "string", "description": "Machine specification for executions.", - "x-example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb" } }, "required": [ @@ -104389,22 +104249,22 @@ "icon": { "type": "string", "description": "Function Template Icon.", - "x-example": "icon-lightning-bolt" + "example": "icon-lightning-bolt" }, "id": { "type": "string", "description": "Function Template ID.", - "x-example": "starter" + "example": "starter" }, "name": { "type": "string", "description": "Function Template Name.", - "x-example": "Starter function" + "example": "Starter function" }, "tagline": { "type": "string", "description": "Function Template Tagline.", - "x-example": "A simple function to get started." + "example": "A simple function to get started." }, "permissions": { "type": "array", @@ -104412,7 +104272,9 @@ "items": { "type": "string" }, - "x-example": "any" + "example": [ + "any" + ] }, "events": { "type": "array", @@ -104420,18 +104282,20 @@ "items": { "type": "string" }, - "x-example": "account.create" + "example": [ + "account.create" + ] }, "cron": { "type": "string", "description": "Function execution schedult in CRON format.", - "x-example": "0 0 * * *" + "example": "0 0 * * *" }, "timeout": { "type": "integer", "description": "Function execution timeout in seconds.", - "x-example": 300, - "format": "int32" + "format": "int32", + "example": 300 }, "useCases": { "type": "array", @@ -104439,7 +104303,9 @@ "items": { "type": "string" }, - "x-example": "Starter" + "example": [ + "Starter" + ] }, "runtimes": { "type": "array", @@ -104447,32 +104313,32 @@ "items": { "$ref": "#\/components\/schemas\/templateRuntime" }, - "x-example": [] + "example": [] }, "instructions": { "type": "string", "description": "Function Template Instructions.", - "x-example": "For documentation and instructions check out <link>." + "example": "For documentation and instructions check out <link>." }, "vcsProvider": { "type": "string", "description": "VCS (Version Control System) Provider.", - "x-example": "github" + "example": "github" }, "providerRepositoryId": { "type": "string", "description": "VCS (Version Control System) Repository ID", - "x-example": "templates" + "example": "templates" }, "providerOwner": { "type": "string", "description": "VCS (Version Control System) Owner.", - "x-example": "appwrite" + "example": "appwrite" }, "providerVersion": { "type": "string", "description": "VCS (Version Control System) branch version (tag).", - "x-example": "main" + "example": "main" }, "variables": { "type": "array", @@ -104480,7 +104346,7 @@ "items": { "$ref": "#\/components\/schemas\/templateVariable" }, - "x-example": [] + "example": [] }, "scopes": { "type": "array", @@ -104488,7 +104354,9 @@ "items": { "type": "string" }, - "x-example": "users.read" + "example": [ + "users.read" + ] } }, "required": [ @@ -104537,22 +104405,22 @@ "name": { "type": "string", "description": "Runtime Name.", - "x-example": "node-19.0" + "example": "node-19.0" }, "commands": { "type": "string", "description": "The build command used to build the deployment.", - "x-example": "npm install" + "example": "npm install" }, "entrypoint": { "type": "string", "description": "The entrypoint file used to execute the deployment.", - "x-example": "index.js" + "example": "index.js" }, "providerRootDirectory": { "type": "string", "description": "Path to function in VCS (Version Control System) repository", - "x-example": "node\/starter" + "example": "node\/starter" } }, "required": [ @@ -104575,37 +104443,37 @@ "name": { "type": "string", "description": "Variable Name.", - "x-example": "APPWRITE_DATABASE_ID" + "example": "APPWRITE_DATABASE_ID" }, "description": { "type": "string", "description": "Variable Description.", - "x-example": "The ID of the Appwrite database that contains the collection to sync." + "example": "The ID of the Appwrite database that contains the collection to sync." }, "value": { "type": "string", "description": "Variable Value.", - "x-example": "512" + "example": "512" }, "secret": { "type": "boolean", "description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.", - "x-example": false + "example": false }, "placeholder": { "type": "string", "description": "Variable Placeholder.", - "x-example": "64a55...7b912" + "example": "64a55...7b912" }, "required": { "type": "boolean", "description": "Is the variable required?", - "x-example": false + "example": false }, "type": { "type": "string", "description": "Variable Type.", - "x-example": "password" + "example": "password" } }, "required": [ @@ -104634,32 +104502,32 @@ "$id": { "type": "string", "description": "Function ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Function creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Function update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "provider": { "type": "string", "description": "VCS (Version Control System) provider name.", - "x-example": "github" + "example": "github" }, "organization": { "type": "string", "description": "VCS (Version Control System) organization name.", - "x-example": "appwrite" + "example": "appwrite" }, "providerInstallationId": { "type": "string", "description": "VCS (Version Control System) installation ID.", - "x-example": "5322" + "example": "5322" } }, "required": [ @@ -104686,47 +104554,47 @@ "id": { "type": "string", "description": "VCS (Version Control System) repository ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "VCS (Version Control System) repository name.", - "x-example": "appwrite" + "example": "appwrite" }, "organization": { "type": "string", "description": "VCS (Version Control System) organization name", - "x-example": "appwrite" + "example": "appwrite" }, "provider": { "type": "string", "description": "VCS (Version Control System) provider name.", - "x-example": "github" + "example": "github" }, "private": { "type": "boolean", "description": "Is VCS (Version Control System) repository private?", - "x-example": true + "example": true }, "defaultBranch": { "type": "string", "description": "VCS (Version Control System) repository's default branch name.", - "x-example": "main" + "example": "main" }, "providerInstallationId": { "type": "string", "description": "VCS (Version Control System) installation ID.", - "x-example": "108104697" + "example": "108104697" }, "authorized": { "type": "boolean", "description": "Is VCS (Version Control System) repository authorized for the installation?", - "x-example": true + "example": true }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", - "x-example": "datetime" + "example": "datetime" }, "variables": { "type": "array", @@ -104734,7 +104602,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "PORT", "NODE_ENV" ] @@ -104775,47 +104643,47 @@ "id": { "type": "string", "description": "VCS (Version Control System) repository ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "VCS (Version Control System) repository name.", - "x-example": "appwrite" + "example": "appwrite" }, "organization": { "type": "string", "description": "VCS (Version Control System) organization name", - "x-example": "appwrite" + "example": "appwrite" }, "provider": { "type": "string", "description": "VCS (Version Control System) provider name.", - "x-example": "github" + "example": "github" }, "private": { "type": "boolean", "description": "Is VCS (Version Control System) repository private?", - "x-example": true + "example": true }, "defaultBranch": { "type": "string", "description": "VCS (Version Control System) repository's default branch name.", - "x-example": "main" + "example": "main" }, "providerInstallationId": { "type": "string", "description": "VCS (Version Control System) installation ID.", - "x-example": "108104697" + "example": "108104697" }, "authorized": { "type": "boolean", "description": "Is VCS (Version Control System) repository authorized for the installation?", - "x-example": true + "example": true }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", - "x-example": "datetime" + "example": "datetime" }, "variables": { "type": "array", @@ -104823,7 +104691,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "PORT", "NODE_ENV" ] @@ -104831,7 +104699,7 @@ "framework": { "type": "string", "description": "Auto-detected framework. Empty if type is not \"framework\".", - "x-example": "nextjs" + "example": "nextjs" } }, "required": [ @@ -104871,47 +104739,47 @@ "id": { "type": "string", "description": "VCS (Version Control System) repository ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "VCS (Version Control System) repository name.", - "x-example": "appwrite" + "example": "appwrite" }, "organization": { "type": "string", "description": "VCS (Version Control System) organization name", - "x-example": "appwrite" + "example": "appwrite" }, "provider": { "type": "string", "description": "VCS (Version Control System) provider name.", - "x-example": "github" + "example": "github" }, "private": { "type": "boolean", "description": "Is VCS (Version Control System) repository private?", - "x-example": true + "example": true }, "defaultBranch": { "type": "string", "description": "VCS (Version Control System) repository's default branch name.", - "x-example": "main" + "example": "main" }, "providerInstallationId": { "type": "string", "description": "VCS (Version Control System) installation ID.", - "x-example": "108104697" + "example": "108104697" }, "authorized": { "type": "boolean", "description": "Is VCS (Version Control System) repository authorized for the installation?", - "x-example": true + "example": true }, "pushedAt": { "type": "string", "description": "Last commit date in ISO 8601 format.", - "x-example": "datetime" + "example": "datetime" }, "variables": { "type": "array", @@ -104919,7 +104787,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "PORT", "NODE_ENV" ] @@ -104927,7 +104795,7 @@ "runtime": { "type": "string", "description": "Auto-detected runtime. Empty if type is not \"runtime\".", - "x-example": "node-22" + "example": "node-22" } }, "required": [ @@ -104967,7 +104835,7 @@ "type": { "type": "string", "description": "Repository detection type.", - "x-example": "framework", + "example": "framework", "enum": [ "framework" ] @@ -104978,28 +104846,28 @@ "items": { "$ref": "#\/components\/schemas\/detectionVariable" }, - "x-example": {}, + "example": [], "nullable": true }, "framework": { "type": "string", "description": "Framework", - "x-example": "nuxt" + "example": "nuxt" }, "installCommand": { "type": "string", "description": "Site Install Command", - "x-example": "npm install" + "example": "npm install" }, "buildCommand": { "type": "string", "description": "Site Build Command", - "x-example": "npm run build" + "example": "npm run build" }, "outputDirectory": { "type": "string", "description": "Site Output Directory", - "x-example": "dist" + "example": "dist" } }, "required": [ @@ -105025,7 +104893,7 @@ "type": { "type": "string", "description": "Repository detection type.", - "x-example": "runtime", + "example": "runtime", "enum": [ "runtime" ] @@ -105036,23 +104904,23 @@ "items": { "$ref": "#\/components\/schemas\/detectionVariable" }, - "x-example": {}, + "example": [], "nullable": true }, "runtime": { "type": "string", "description": "Runtime", - "x-example": "node" + "example": "node" }, "entrypoint": { "type": "string", "description": "Function Entrypoint", - "x-example": "index.js" + "example": "index.js" }, "commands": { "type": "string", "description": "Function install and build commands", - "x-example": "npm install && npm run build" + "example": "npm install && npm run build" } }, "required": [ @@ -105076,12 +104944,12 @@ "name": { "type": "string", "description": "Name of environment variable", - "x-example": "NODE_ENV" + "example": "NODE_ENV" }, "value": { "type": "string", "description": "Value of environment variable", - "x-example": "production" + "example": "production" } }, "required": [ @@ -105100,20 +104968,20 @@ "size": { "type": "integer", "description": "Content size in bytes. Only files have size, and for directories, 0 is returned.", - "x-example": 1523, "format": "int32", + "example": 1523, "nullable": true }, "isDirectory": { "type": "boolean", "description": "If a content is a directory. Directories can be used to check nested contents.", - "x-example": true, + "example": true, "nullable": true }, "name": { "type": "string", "description": "Name of directory or file.", - "x-example": "Main.java" + "example": "Main.java" } }, "required": [ @@ -105132,7 +105000,7 @@ "name": { "type": "string", "description": "Branch Name.", - "x-example": "main" + "example": "main" } }, "required": [ @@ -105149,37 +105017,37 @@ "$id": { "type": "string", "description": "Runtime ID.", - "x-example": "python-3.8" + "example": "python-3.8" }, "key": { "type": "string", "description": "Parent runtime key.", - "x-example": "python" + "example": "python" }, "name": { "type": "string", "description": "Runtime Name.", - "x-example": "Python" + "example": "Python" }, "version": { "type": "string", "description": "Runtime version.", - "x-example": "3.8" + "example": "3.8" }, "base": { "type": "string", "description": "Base Docker image used to build the runtime.", - "x-example": "python:3.8-alpine" + "example": "python:3.8-alpine" }, "image": { "type": "string", "description": "Image name of Docker Hub.", - "x-example": "appwrite\\\/runtime-for-python:3.8" + "example": "appwrite\\\/runtime-for-python:3.8" }, "logo": { "type": "string", "description": "Name of the logo image.", - "x-example": "python.png" + "example": "python.png" }, "supports": { "type": "array", @@ -105187,7 +105055,9 @@ "items": { "type": "string" }, - "x-example": "amd64" + "example": [ + "amd64" + ] } }, "required": [ @@ -105218,17 +105088,17 @@ "key": { "type": "string", "description": "Framework key.", - "x-example": "sveltekit" + "example": "sveltekit" }, "name": { "type": "string", "description": "Framework Name.", - "x-example": "SvelteKit" + "example": "SvelteKit" }, "buildRuntime": { "type": "string", "description": "Default runtime version.", - "x-example": "node-22" + "example": "node-22" }, "runtimes": { "type": "array", @@ -105236,7 +105106,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "static-1", "node-22" ] @@ -105247,7 +105117,7 @@ "items": { "$ref": "#\/components\/schemas\/frameworkAdapter" }, - "x-example": [ + "example": [ { "key": "static", "buildRuntime": "node-22", @@ -105291,27 +105161,27 @@ "key": { "type": "string", "description": "Adapter key.", - "x-example": "static" + "example": "static" }, "installCommand": { "type": "string", "description": "Default command to download dependencies.", - "x-example": "npm install" + "example": "npm install" }, "buildCommand": { "type": "string", "description": "Default command to build site into output directory.", - "x-example": "npm run build" + "example": "npm run build" }, "outputDirectory": { "type": "string", "description": "Default output directory of build.", - "x-example": ".\/dist" + "example": ".\/dist" }, "fallbackFile": { "type": "string", "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "example": "index.html" } }, "required": [ @@ -105336,80 +105206,80 @@ "$id": { "type": "string", "description": "Deployment ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Deployment update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "type": { "type": "string", "description": "Type of deployment.", - "x-example": "vcs" + "example": "vcs" }, "resourceId": { "type": "string", "description": "Resource ID.", - "x-example": "5e5ea6g16897e" + "example": "5e5ea6g16897e" }, "resourceType": { "type": "string", "description": "Resource type.", - "x-example": "functions" + "example": "functions" }, "entrypoint": { "type": "string", "description": "The entrypoint file to use to execute the deployment code.", - "x-example": "index.js" + "example": "index.js" }, "sourceSize": { "type": "integer", "description": "The code size in bytes.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "buildSize": { "type": "integer", "description": "The build output size in bytes.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "totalSize": { "type": "integer", "description": "The total size in bytes (source and build output).", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "buildId": { "type": "string", "description": "The current build ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "activate": { "type": "boolean", "description": "Whether the deployment should be automatically activated.", - "x-example": true + "example": true }, "screenshotLight": { "type": "string", "description": "Screenshot with light theme preference file ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "screenshotDark": { "type": "string", "description": "Screenshot with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "status": { "type": "string", "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", - "x-example": "ready", + "example": "ready", "enum": [ "waiting", "processing", @@ -105422,63 +105292,63 @@ "buildLogs": { "type": "string", "description": "The build logs.", - "x-example": "Compiling source files..." + "example": "Compiling source files..." }, "buildDuration": { "type": "integer", "description": "The current build time in seconds.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "providerRepositoryName": { "type": "string", "description": "The name of the vcs provider repository", - "x-example": "database" + "example": "database" }, "providerRepositoryOwner": { "type": "string", "description": "The name of the vcs provider repository owner", - "x-example": "utopia" + "example": "utopia" }, "providerRepositoryUrl": { "type": "string", "description": "The url of the vcs provider repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" + "example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" }, "providerCommitHash": { "type": "string", "description": "The commit hash of the vcs commit", - "x-example": "7c3f25d" + "example": "7c3f25d" }, "providerCommitAuthorUrl": { "type": "string", "description": "The url of vcs commit author", - "x-example": "https:\/\/github.com\/vermakhushboo" + "example": "https:\/\/github.com\/vermakhushboo" }, "providerCommitAuthor": { "type": "string", "description": "The name of vcs commit author", - "x-example": "Khushboo Verma" + "example": "Khushboo Verma" }, "providerCommitMessage": { "type": "string", "description": "The commit message", - "x-example": "Update index.js" + "example": "Update index.js" }, "providerCommitUrl": { "type": "string", "description": "The url of the vcs commit", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + "example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" }, "providerBranch": { "type": "string", "description": "The branch of the vcs repository", - "x-example": "0.7.x" + "example": "0.7.x" }, "providerBranchUrl": { "type": "string", "description": "The branch of the vcs repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" } }, "required": [ @@ -105547,17 +105417,17 @@ "$id": { "type": "string", "description": "Execution ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Execution creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Execution update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -105565,19 +105435,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "any" ] }, "resourceId": { "type": "string", "description": "Function or site ID.", - "x-example": "5e5ea6g16897e" + "example": "5e5ea6g16897e" }, "resourceType": { "type": "string", "description": "Execution resource type.", - "x-example": "functions", + "example": "functions", "enum": [ "functions", "sites" @@ -105586,12 +105456,12 @@ "deploymentId": { "type": "string", "description": "Deployment ID used to create the execution.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "trigger": { "type": "string", "description": "The trigger that caused the resource to execute. Possible values can be: `http`, `schedule`, or `event`.", - "x-example": "http", + "example": "http", "enum": [ "http", "schedule", @@ -105601,7 +105471,7 @@ "status": { "type": "string", "description": "The status of the resource execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", - "x-example": "processing", + "example": "processing", "enum": [ "waiting", "processing", @@ -105613,12 +105483,12 @@ "requestMethod": { "type": "string", "description": "HTTP request method type.", - "x-example": "GET" + "example": "GET" }, "requestPath": { "type": "string", "description": "HTTP request path and query.", - "x-example": "\/articles?id=5" + "example": "\/articles?id=5" }, "requestHeaders": { "type": "array", @@ -105626,7 +105496,7 @@ "items": { "$ref": "#\/components\/schemas\/headers" }, - "x-example": [ + "example": [ { "Content-Type": "application\/json" } @@ -105635,13 +105505,13 @@ "responseStatusCode": { "type": "integer", "description": "HTTP response status code.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 }, "responseBody": { "type": "string", "description": "HTTP response body. This will return empty unless execution is created as synchronous.", - "x-example": "" + "example": "" }, "responseHeaders": { "type": "array", @@ -105649,7 +105519,7 @@ "items": { "$ref": "#\/components\/schemas\/headers" }, - "x-example": [ + "example": [ { "Content-Type": "application\/json" } @@ -105658,23 +105528,23 @@ "logs": { "type": "string", "description": "Resource logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "example": "" }, "errors": { "type": "string", "description": "Resource errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "example": "" }, "duration": { "type": "number", "description": "Resource(function\/site) execution duration in seconds.", - "x-example": 0.4, - "format": "double" + "format": "double", + "example": 0.4 }, "scheduledAt": { "type": "string", "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -105737,32 +105607,32 @@ "$id": { "type": "string", "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Project creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Project update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Project name.", - "x-example": "New Project" + "example": "New Project" }, "teamId": { "type": "string", "description": "Project team ID.", - "x-example": "1592981250" + "example": "1592981250" }, "region": { "type": "string", "description": "Project region", - "x-example": "fra" + "example": "fra" }, "devKeys": { "type": "array", @@ -105770,70 +105640,70 @@ "items": { "$ref": "#\/components\/schemas\/devKey" }, - "x-example": {} + "example": [] }, "smtpEnabled": { "type": "boolean", "description": "Status for custom SMTP", - "x-example": false + "example": false }, "smtpSenderName": { "type": "string", "description": "SMTP sender name", - "x-example": "John Appwrite" + "example": "John Appwrite" }, "smtpSenderEmail": { "type": "string", "description": "SMTP sender email", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "smtpReplyToName": { "type": "string", "description": "SMTP reply to name", - "x-example": "Support Team" + "example": "Support Team" }, "smtpReplyToEmail": { "type": "string", "description": "SMTP reply to email", - "x-example": "support@appwrite.io" + "example": "support@appwrite.io" }, "smtpHost": { "type": "string", "description": "SMTP server host name", - "x-example": "mail.appwrite.io" + "example": "mail.appwrite.io" }, "smtpPort": { "type": "integer", "description": "SMTP server port", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "smtpUsername": { "type": "string", "description": "SMTP server username", - "x-example": "emailuser" + "example": "emailuser" }, "smtpPassword": { "type": "string", "description": "SMTP server password. This property is write-only and always returned empty.", - "x-example": "smtp-password", - "format": "password" + "format": "password", + "example": "smtp-password" }, "smtpSecure": { "type": "string", "description": "SMTP server secure protocol", - "x-example": "tls" + "example": "tls" }, "pingCount": { "type": "integer", "description": "Number of times the ping was received for this project.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "pingedAt": { "type": "string", "description": "Last ping datetime in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "labels": { "type": "array", @@ -105841,20 +105711,20 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "vip" ] }, "status": { "type": "string", "description": "Project status", - "x-example": "active" + "example": "active" }, "onboarding": { "type": "object", "additionalProperties": true, "description": "Stage progress (completed or skipped) with timestamps and actor types, keyed by stage id.", - "x-example": [] + "example": {} }, "authMethods": { "type": "array", @@ -105862,7 +105732,7 @@ "items": { "$ref": "#\/components\/schemas\/projectAuthMethod" }, - "x-example": {} + "example": [] }, "services": { "type": "array", @@ -105870,7 +105740,7 @@ "items": { "$ref": "#\/components\/schemas\/projectService" }, - "x-example": {} + "example": [] }, "protocols": { "type": "array", @@ -105878,30 +105748,28 @@ "items": { "$ref": "#\/components\/schemas\/projectProtocol" }, - "x-example": {} + "example": [] }, "blocks": { "type": "array", "description": "Project blocks information", "items": { "$ref": "#\/components\/schemas\/block" - }, - "x-example": "" + } }, "consoleAccessedAt": { "type": "string", "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "wafEnabled": { "type": "boolean", "description": "Whether WAF enforcement is enabled for the project.", - "x-example": true + "example": true }, "billingLimits": { "type": "object", "description": "Billing limits reached", - "x-example": "", "allOf": [ { "$ref": "#\/components\/schemas\/billingLimits" @@ -105912,13 +105780,13 @@ "oAuth2ServerEnabled": { "type": "boolean", "description": "OAuth2 server status", - "x-example": false, + "example": false, "nullable": true }, "oAuth2ServerAuthorizationUrl": { "type": "string", "description": "OAuth2 server authorization URL", - "x-example": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration", + "example": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration", "nullable": true }, "oAuth2ServerScopes": { @@ -105927,7 +105795,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read", "write" ], @@ -105939,7 +105807,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read" ], "nullable": true @@ -105950,7 +105818,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "project:all" ], "nullable": true @@ -105961,7 +105829,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "calendar" ], "nullable": true @@ -105969,74 +105837,74 @@ "oAuth2ServerAccessTokenDuration": { "type": "integer", "description": "OAuth2 server access token duration in seconds for confidential clients", - "x-example": 3600, "format": "int32", + "example": 3600, "nullable": true }, "oAuth2ServerRefreshTokenDuration": { "type": "integer", "description": "OAuth2 server refresh token duration in seconds for confidential clients", - "x-example": 86400, "format": "int32", + "example": 86400, "nullable": true }, "oAuth2ServerPublicAccessTokenDuration": { "type": "integer", "description": "OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)", - "x-example": 3600, "format": "int32", + "example": 3600, "nullable": true }, "oAuth2ServerPublicRefreshTokenDuration": { "type": "integer", "description": "OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)", - "x-example": 2592000, "format": "int32", + "example": 2592000, "nullable": true }, "oAuth2ServerInstallationAccessTokenDuration": { "type": "integer", "description": "OAuth2 server access token duration in seconds for app installation access tokens", - "x-example": 3600, "format": "int32", + "example": 3600, "nullable": true }, "oAuth2ServerConfidentialPkce": { "type": "boolean", "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", - "x-example": false, + "example": false, "nullable": true }, "oAuth2ServerVerificationUrl": { "type": "string", "description": "URL to your application page where users enter the device flow user code. Empty when the Device Authorization Grant is not configured.", - "x-example": "https:\/\/cloud.appwrite.io\/device", + "example": "https:\/\/cloud.appwrite.io\/device", "nullable": true }, "oAuth2ServerUserCodeLength": { "type": "integer", "description": "Number of characters in the device flow user code, excluding the formatting separator.", - "x-example": 8, "format": "int32", + "example": 8, "nullable": true }, "oAuth2ServerUserCodeFormat": { "type": "string", "description": "Character set for device flow user codes: `numeric`, `alphabetic`, or `alphanumeric`.", - "x-example": "alphanumeric", + "example": "alphanumeric", "nullable": true }, "oAuth2ServerDeviceCodeDuration": { "type": "integer", "description": "Lifetime in seconds of device flow device codes and user codes.", - "x-example": 600, "format": "int32", + "example": 600, "nullable": true }, "oAuth2ServerDiscoveryUrl": { "type": "string", "description": "OAuth2 server discovery URL", - "x-example": "https:\/\/auth.example.com\/.well-known\/openid-configuration", + "example": "https:\/\/auth.example.com\/.well-known\/openid-configuration", "nullable": true } }, @@ -106137,7 +106005,7 @@ "$id": { "type": "string", "description": "Auth method ID.", - "x-example": "email-password", + "example": "email-password", "enum": [ "email-password", "magic-url", @@ -106152,7 +106020,7 @@ "enabled": { "type": "boolean", "description": "Auth method status.", - "x-example": false + "example": false } }, "required": [ @@ -106171,7 +106039,7 @@ "$id": { "type": "string", "description": "Service ID.", - "x-example": "sites", + "example": "sites", "enum": [ "account", "avatars", @@ -106197,7 +106065,7 @@ "enabled": { "type": "boolean", "description": "Service status.", - "x-example": false + "example": false } }, "required": [ @@ -106216,7 +106084,7 @@ "$id": { "type": "string", "description": "Protocol ID.", - "x-example": "graphql", + "example": "graphql", "enum": [ "rest", "graphql", @@ -106227,7 +106095,7 @@ "enabled": { "type": "boolean", "description": "Protocol status.", - "x-example": false + "example": false } }, "required": [ @@ -106246,27 +106114,27 @@ "$id": { "type": "string", "description": "Webhook ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Webhook creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Webhook update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Webhook name.", - "x-example": "My Webhook" + "example": "My Webhook" }, "url": { "type": "string", "description": "Webhook URL endpoint.", - "x-example": "https:\/\/example.com\/webhook" + "example": "https:\/\/example.com\/webhook" }, "events": { "type": "array", @@ -106274,7 +106142,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "databases.tables.update", "databases.collections.update" ] @@ -106282,39 +106150,39 @@ "tls": { "type": "boolean", "description": "Indicates if SSL \/ TLS certificate verification is enabled.", - "x-example": true + "example": true }, "authUsername": { "type": "string", "description": "HTTP basic authentication username.", - "x-example": "username" + "example": "username" }, "authPassword": { "type": "string", "description": "HTTP basic authentication password.", - "x-example": "webhook-password", - "format": "password" + "format": "password", + "example": "webhook-password" }, "secret": { "type": "string", "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", - "x-example": "ad3d581ca230e2b7059c545e5a" + "example": "ad3d581ca230e2b7059c545e5a" }, "enabled": { "type": "boolean", "description": "Indicates if this webhook is enabled.", - "x-example": true + "example": true }, "logs": { "type": "string", "description": "Webhook error logs from the most recent failure.", - "x-example": "Failed to connect to remote server." + "example": "Failed to connect to remote server." }, "attempts": { "type": "integer", "description": "Number of consecutive failed webhook attempts.", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 } }, "required": [ @@ -106358,27 +106226,27 @@ "$id": { "type": "string", "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Key name.", - "x-example": "My API Key" + "example": "My API Key" }, "expire": { "type": "string", "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "scopes": { "type": "array", @@ -106386,17 +106254,19 @@ "items": { "type": "string" }, - "x-example": "users.read" + "example": [ + "users.read" + ] }, "secret": { "type": "string", "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "example": "919c2d18fb5d4...a2ae413da83346ad2" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "sdks": { "type": "array", @@ -106404,7 +106274,9 @@ "items": { "type": "string" }, - "x-example": "appwrite:flutter" + "example": [ + "appwrite:flutter" + ] } }, "required": [ @@ -106437,27 +106309,27 @@ "$id": { "type": "string", "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Key name.", - "x-example": "My API Key" + "example": "My API Key" }, "expire": { "type": "string", "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "scopes": { "type": "array", @@ -106465,17 +106337,19 @@ "items": { "type": "string" }, - "x-example": "users.read" + "example": [ + "users.read" + ] }, "secret": { "type": "string", "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "example": "919c2d18fb5d4...a2ae413da83346ad2" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "sdks": { "type": "array", @@ -106483,7 +106357,9 @@ "items": { "type": "string" }, - "x-example": "appwrite:flutter" + "example": [ + "appwrite:flutter" + ] } }, "required": [ @@ -106516,37 +106392,37 @@ "$id": { "type": "string", "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Key name.", - "x-example": "Dev API Key" + "example": "Dev API Key" }, "expire": { "type": "string", "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "secret": { "type": "string", "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "example": "919c2d18fb5d4...a2ae413da83346ad2" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "sdks": { "type": "array", @@ -106554,7 +106430,9 @@ "items": { "type": "string" }, - "x-example": "appwrite:flutter" + "example": [ + "appwrite:flutter" + ] } }, "required": [ @@ -106585,22 +106463,22 @@ "number": { "type": "string", "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", - "x-example": "+1612842323" + "example": "+1612842323" }, "otp": { "type": "string", "description": "Mock OTP for the number. ", - "x-example": "123456" + "example": "123456" }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -106623,22 +106501,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "GitHub OAuth2 client ID. For GitHub Apps, use the \"App ID\" when both an App ID and client ID are available.", - "x-example": "e4d87900000000540733" + "example": "e4d87900000000540733" }, "clientSecret": { "type": "string", "description": "GitHub OAuth2 client secret.", - "x-example": "5e07c00000000000000000000000000000198bcc" + "example": "5e07c00000000000000000000000000000198bcc" } }, "required": [ @@ -106661,22 +106539,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Discord OAuth2 client ID.", - "x-example": "950722000000343754" + "example": "950722000000343754" }, "clientSecret": { "type": "string", "description": "Discord OAuth2 client secret.", - "x-example": "YmPXnM000000000000000000002zFg5D" + "example": "YmPXnM000000000000000000002zFg5D" } }, "required": [ @@ -106699,22 +106577,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Figma OAuth2 client ID.", - "x-example": "byay5H0000000000VtiI40" + "example": "byay5H0000000000VtiI40" }, "clientSecret": { "type": "string", "description": "Figma OAuth2 client secret.", - "x-example": "yEpOYn0000000000000000004iIsU5" + "example": "yEpOYn0000000000000000004iIsU5" } }, "required": [ @@ -106737,22 +106615,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "appKey": { "type": "string", "description": "Dropbox OAuth2 app key.", - "x-example": "jl000000000009t" + "example": "jl000000000009t" }, "appSecret": { "type": "string", "description": "Dropbox OAuth2 app secret.", - "x-example": "g200000000000vw" + "example": "g200000000000vw" } }, "required": [ @@ -106775,22 +106653,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "apiKey": { "type": "string", "description": "Dailymotion OAuth2 API key.", - "x-example": "07a9000000000000067f" + "example": "07a9000000000000067f" }, "apiSecret": { "type": "string", "description": "Dailymotion OAuth2 API secret.", - "x-example": "a399a90000000000000000000000000000d90639" + "example": "a399a90000000000000000000000000000d90639" } }, "required": [ @@ -106813,22 +106691,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "key": { "type": "string", "description": "Bitbucket OAuth2 key.", - "x-example": "Knt70000000000ByRc" + "example": "Knt70000000000ByRc" }, "secret": { "type": "string", "description": "Bitbucket OAuth2 secret.", - "x-example": "NMfLZJ00000000000000000000TLQdDx" + "example": "NMfLZJ00000000000000000000TLQdDx" } }, "required": [ @@ -106851,22 +106729,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Bitly OAuth2 client ID.", - "x-example": "d95151000000000000000000000000000067af9b" + "example": "d95151000000000000000000000000000067af9b" }, "clientSecret": { "type": "string", "description": "Bitly OAuth2 client secret.", - "x-example": "a13e250000000000000000000000000000d73095" + "example": "a13e250000000000000000000000000000d73095" } }, "required": [ @@ -106889,22 +106767,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Box OAuth2 client ID.", - "x-example": "deglcs00000000000000000000x2og6y" + "example": "deglcs00000000000000000000x2og6y" }, "clientSecret": { "type": "string", "description": "Box OAuth2 client secret.", - "x-example": "OKM1f100000000000000000000eshEif" + "example": "OKM1f100000000000000000000eshEif" } }, "required": [ @@ -106927,22 +106805,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Autodesk OAuth2 client ID.", - "x-example": "5zw90v00000000000000000000kVYXN7" + "example": "5zw90v00000000000000000000kVYXN7" }, "clientSecret": { "type": "string", "description": "Autodesk OAuth2 client secret.", - "x-example": "7I000000000000MW" + "example": "7I000000000000MW" } }, "required": [ @@ -106965,22 +106843,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Google OAuth2 client ID.", - "x-example": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com" + "example": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com" }, "clientSecret": { "type": "string", "description": "Google OAuth2 client secret.", - "x-example": "GOCSPX-2k8gsR0000000000000000VNahJj" + "example": "GOCSPX-2k8gsR0000000000000000VNahJj" }, "prompt": { "type": "array", @@ -106993,7 +106871,7 @@ "select_account" ] }, - "x-example": [ + "example": [ "consent" ] } @@ -107022,22 +106900,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Zoom OAuth2 client ID.", - "x-example": "QMAC00000000000000w0AQ" + "example": "QMAC00000000000000w0AQ" }, "clientSecret": { "type": "string", "description": "Zoom OAuth2 client secret.", - "x-example": "GAWsG4000000000000000000007U01ON" + "example": "GAWsG4000000000000000000007U01ON" } }, "required": [ @@ -107060,22 +106938,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Zoho OAuth2 client ID.", - "x-example": "1000.83C178000000000000000000RPNX0B" + "example": "1000.83C178000000000000000000RPNX0B" }, "clientSecret": { "type": "string", "description": "Zoho OAuth2 client secret.", - "x-example": "fb5cac000000000000000000000000000000a68f6e" + "example": "fb5cac000000000000000000000000000000a68f6e" } }, "required": [ @@ -107098,22 +106976,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Yandex OAuth2 client ID.", - "x-example": "6a8a6a0000000000000000000091483c" + "example": "6a8a6a0000000000000000000091483c" }, "clientSecret": { "type": "string", "description": "Yandex OAuth2 client secret.", - "x-example": "bbf98500000000000000000000c75a63" + "example": "bbf98500000000000000000000c75a63" } }, "required": [ @@ -107136,22 +107014,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "customerKey": { "type": "string", "description": "X OAuth2 customer key.", - "x-example": "slzZV0000000000000NFLaWT" + "example": "slzZV0000000000000NFLaWT" }, "secretKey": { "type": "string", "description": "X OAuth2 secret key.", - "x-example": "tkEPkp00000000000000000000000000000000000000FTxbI9" + "example": "tkEPkp00000000000000000000000000000000000000FTxbI9" } }, "required": [ @@ -107174,22 +107052,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "WordPress OAuth2 client ID.", - "x-example": "130005" + "example": "130005" }, "clientSecret": { "type": "string", "description": "WordPress OAuth2 client secret.", - "x-example": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" + "example": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" } }, "required": [ @@ -107212,22 +107090,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Twitch OAuth2 client ID.", - "x-example": "vvi0in000000000000000000ikmt9p" + "example": "vvi0in000000000000000000ikmt9p" }, "clientSecret": { "type": "string", "description": "Twitch OAuth2 client secret.", - "x-example": "pmapue000000000000000000zylw3v" + "example": "pmapue000000000000000000zylw3v" } }, "required": [ @@ -107250,22 +107128,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Stripe OAuth2 client ID.", - "x-example": "ca_UKibXX0000000000000000000006byvR" + "example": "ca_UKibXX0000000000000000000006byvR" }, "apiSecretKey": { "type": "string", "description": "Stripe OAuth2 API secret key.", - "x-example": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + "example": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" } }, "required": [ @@ -107288,22 +107166,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Spotify OAuth2 client ID.", - "x-example": "6ec271000000000000000000009beace" + "example": "6ec271000000000000000000009beace" }, "clientSecret": { "type": "string", "description": "Spotify OAuth2 client secret.", - "x-example": "db068a000000000000000000008b5b9f" + "example": "db068a000000000000000000008b5b9f" } }, "required": [ @@ -107326,22 +107204,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Slack OAuth2 client ID.", - "x-example": "23000000089.15000000000023" + "example": "23000000089.15000000000023" }, "clientSecret": { "type": "string", "description": "Slack OAuth2 client secret.", - "x-example": "81656000000000000000000000f3d2fd" + "example": "81656000000000000000000000f3d2fd" } }, "required": [ @@ -107364,22 +107242,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Podio OAuth2 client ID.", - "x-example": "appwrite-oauth-test-app" + "example": "appwrite-oauth-test-app" }, "clientSecret": { "type": "string", "description": "Podio OAuth2 client secret.", - "x-example": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + "example": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" } }, "required": [ @@ -107402,22 +107280,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "oauthClientId": { "type": "string", "description": "Notion OAuth2 client ID.", - "x-example": "341d8700-0000-0000-0000-000000446ee3" + "example": "341d8700-0000-0000-0000-000000446ee3" }, "oauthClientSecret": { "type": "string", "description": "Notion OAuth2 client secret.", - "x-example": "secret_dLUr4b000000000000000000000000000000lFHAa9" + "example": "secret_dLUr4b000000000000000000000000000000lFHAa9" } }, "required": [ @@ -107440,22 +107318,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "customerKey": { "type": "string", "description": "Salesforce OAuth2 consumer key.", - "x-example": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq" + "example": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq" }, "customerSecret": { "type": "string", "description": "Salesforce OAuth2 consumer secret.", - "x-example": "3w000000000000e2" + "example": "3w000000000000e2" } }, "required": [ @@ -107478,22 +107356,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Yahoo OAuth2 client ID.", - "x-example": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm" + "example": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm" }, "clientSecret": { "type": "string", "description": "Yahoo OAuth2 client secret.", - "x-example": "cf978f0000000000000000000000000000c5e2e9" + "example": "cf978f0000000000000000000000000000c5e2e9" } }, "required": [ @@ -107516,22 +107394,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "LinkedIn OAuth2 client ID.", - "x-example": "770000000000dv" + "example": "770000000000dv" }, "primaryClientSecret": { "type": "string", "description": "LinkedIn OAuth2 primary client secret.", - "x-example": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + "example": "WPL_AP1.2Bf0000000000000.\/HtlYw==" } }, "required": [ @@ -107554,22 +107432,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "publicKey": { "type": "string", "description": "Disqus OAuth2 public key.", - "x-example": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX" + "example": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX" }, "secretKey": { "type": "string", "description": "Disqus OAuth2 secret key.", - "x-example": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + "example": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" } }, "required": [ @@ -107592,22 +107470,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Amazon OAuth2 client ID.", - "x-example": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2" + "example": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2" }, "clientSecret": { "type": "string", "description": "Amazon OAuth2 client secret.", - "x-example": "79ffe4000000000000000000000000000000000000000000000000000002de55" + "example": "79ffe4000000000000000000000000000000000000000000000000000002de55" } }, "required": [ @@ -107630,22 +107508,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "keyString": { "type": "string", "description": "Etsy OAuth2 keystring.", - "x-example": "nsgzxh0000000000008j85a2" + "example": "nsgzxh0000000000008j85a2" }, "sharedSecret": { "type": "string", "description": "Etsy OAuth2 shared secret.", - "x-example": "tp000000ru" + "example": "tp000000ru" } }, "required": [ @@ -107668,22 +107546,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "appId": { "type": "string", "description": "Facebook OAuth2 app ID.", - "x-example": "260600000007694" + "example": "260600000007694" }, "appSecret": { "type": "string", "description": "Facebook OAuth2 app secret.", - "x-example": "2d0b2800000000000000000000d38af4" + "example": "2d0b2800000000000000000000d38af4" } }, "required": [ @@ -107706,22 +107584,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "oauth2ClientId": { "type": "string", "description": "Tradeshift OAuth2 client ID.", - "x-example": "appwrite-test-org.appwrite-test-app" + "example": "appwrite-test-org.appwrite-test-app" }, "oauth2ClientSecret": { "type": "string", "description": "Tradeshift OAuth2 client secret.", - "x-example": "7cb52700-0000-0000-0000-000000ca5b83" + "example": "7cb52700-0000-0000-0000-000000ca5b83" } }, "required": [ @@ -107744,22 +107622,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "PayPal OAuth2 client ID.", - "x-example": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB" + "example": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB" }, "secretKey": { "type": "string", "description": "PayPal OAuth2 secret key.", - "x-example": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + "example": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" } }, "required": [ @@ -107782,27 +107660,27 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "applicationId": { "type": "string", "description": "GitLab OAuth2 application ID.", - "x-example": "d41ffe0000000000000000000000000000000000000000000000000000d5e252" + "example": "d41ffe0000000000000000000000000000000000000000000000000000d5e252" }, "secret": { "type": "string", "description": "GitLab OAuth2 secret.", - "x-example": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38" + "example": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38" }, "endpoint": { "type": "string", "description": "GitLab OAuth2 endpoint URL. Defaults to https:\/\/gitlab.com for self-hosted instances.", - "x-example": "https:\/\/gitlab.com" + "example": "https:\/\/gitlab.com" } }, "required": [ @@ -107827,22 +107705,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Appwrite OAuth2 client ID.", - "x-example": "6a42000000000000b5a0" + "example": "6a42000000000000b5a0" }, "clientSecret": { "type": "string", "description": "Appwrite OAuth2 client secret.", - "x-example": "b86afd000000000000000000000000000000000000000000000000000ced5f93" + "example": "b86afd000000000000000000000000000000000000000000000000000ced5f93" } }, "required": [ @@ -107865,27 +107743,27 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Authentik OAuth2 client ID.", - "x-example": "dTKOPa0000000000000000000000000000e7G8hv" + "example": "dTKOPa0000000000000000000000000000e7G8hv" }, "clientSecret": { "type": "string", "description": "Authentik OAuth2 client secret.", - "x-example": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK" + "example": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK" }, "endpoint": { "type": "string", "description": "Authentik OAuth2 endpoint domain.", - "x-example": "example.authentik.com" + "example": "example.authentik.com" } }, "required": [ @@ -107910,27 +107788,27 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Auth0 OAuth2 client ID.", - "x-example": "OaOkIA000000000000000000005KLSYq" + "example": "OaOkIA000000000000000000005KLSYq" }, "clientSecret": { "type": "string", "description": "Auth0 OAuth2 client secret.", - "x-example": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF" + "example": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF" }, "endpoint": { "type": "string", "description": "Auth0 OAuth2 endpoint domain.", - "x-example": "example.us.auth0.com" + "example": "example.us.auth0.com" } }, "required": [ @@ -107955,27 +107833,27 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "FusionAuth OAuth2 client ID.", - "x-example": "b2222c00-0000-0000-0000-000000862097" + "example": "b2222c00-0000-0000-0000-000000862097" }, "clientSecret": { "type": "string", "description": "FusionAuth OAuth2 client secret.", - "x-example": "Jx4s0C0000000000000000000000000000000wGqLsc" + "example": "Jx4s0C0000000000000000000000000000000wGqLsc" }, "endpoint": { "type": "string", "description": "FusionAuth OAuth2 endpoint domain.", - "x-example": "example.fusionauth.io" + "example": "example.fusionauth.io" } }, "required": [ @@ -108000,32 +107878,32 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Keycloak OAuth2 client ID.", - "x-example": "appwrite-o0000000st-app" + "example": "appwrite-o0000000st-app" }, "clientSecret": { "type": "string", "description": "Keycloak OAuth2 client secret.", - "x-example": "jdjrJd00000000000000000000HUsaZO" + "example": "jdjrJd00000000000000000000HUsaZO" }, "endpoint": { "type": "string", "description": "Keycloak OAuth2 endpoint domain.", - "x-example": "keycloak.example.com" + "example": "keycloak.example.com" }, "realmName": { "type": "string", "description": "Keycloak OAuth2 realm name.", - "x-example": "appwrite-realm" + "example": "appwrite-realm" } }, "required": [ @@ -108052,42 +107930,42 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "OpenID Connect OAuth2 client ID.", - "x-example": "qibI2x0000000000000000000000000006L2YFoG" + "example": "qibI2x0000000000000000000000000006L2YFoG" }, "clientSecret": { "type": "string", "description": "OpenID Connect OAuth2 client secret.", - "x-example": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV" + "example": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV" }, "wellKnownURL": { "type": "string", "description": "OpenID Connect well-known configuration URL. When set, authorization, token, and user info endpoints can be discovered automatically.", - "x-example": "https:\/\/myoauth.com\/.well-known\/openid-configuration" + "example": "https:\/\/myoauth.com\/.well-known\/openid-configuration" }, "authorizationURL": { "type": "string", "description": "OpenID Connect authorization endpoint URL.", - "x-example": "https:\/\/myoauth.com\/oauth2\/authorize" + "example": "https:\/\/myoauth.com\/oauth2\/authorize" }, "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL.", - "x-example": "https:\/\/myoauth.com\/oauth2\/token" + "example": "https:\/\/myoauth.com\/oauth2\/token" }, "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL.", - "x-example": "https:\/\/myoauth.com\/oauth2\/userinfo" + "example": "https:\/\/myoauth.com\/oauth2\/userinfo" }, "prompt": { "type": "array", @@ -108101,15 +107979,15 @@ "select_account" ] }, - "x-example": [ + "example": [ "consent" ] }, "maxAge": { "type": "integer", "description": "Maximum authentication age in seconds. When set, the user must have authenticated within this many seconds.", - "x-example": 3600, "format": "int32", + "example": 3600, "nullable": true } }, @@ -108146,32 +108024,32 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Okta OAuth2 client ID.", - "x-example": "0oa00000000000000698" + "example": "0oa00000000000000698" }, "clientSecret": { "type": "string", "description": "Okta OAuth2 client secret.", - "x-example": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV" + "example": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV" }, "domain": { "type": "string", "description": "Okta OAuth2 domain.", - "x-example": "trial-6400025.okta.com" + "example": "trial-6400025.okta.com" }, "authorizationServerId": { "type": "string", "description": "Okta OAuth2 authorization server ID.", - "x-example": "aus000000000000000h7z" + "example": "aus000000000000000h7z" } }, "required": [ @@ -108198,22 +108076,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Kick OAuth2 client ID.", - "x-example": "01KQ7C00000000000001MFHS32" + "example": "01KQ7C00000000000001MFHS32" }, "clientSecret": { "type": "string", "description": "Kick OAuth2 client secret.", - "x-example": "34ac5600000000000000000000000000000000000000000000000000e830c8b" + "example": "34ac5600000000000000000000000000000000000000000000000000e830c8b" } }, "required": [ @@ -108236,32 +108114,32 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "apple" + "example": "apple" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "serviceId": { "type": "string", "description": "Apple OAuth2 service ID.", - "x-example": "ip.appwrite.app.web" + "example": "ip.appwrite.app.web" }, "keyId": { "type": "string", "description": "Apple OAuth2 key ID.", - "x-example": "P4000000N8" + "example": "P4000000N8" }, "teamId": { "type": "string", "description": "Apple OAuth2 team ID.", - "x-example": "D4000000R6" + "example": "D4000000R6" }, "p8File": { "type": "string", "description": "Apple OAuth2 .p8 private key file contents. The secret key wrapped by the PEM markers is 200 characters long.", - "x-example": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" + "example": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" } }, "required": [ @@ -108288,27 +108166,27 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "applicationId": { "type": "string", "description": "Microsoft OAuth2 application ID.", - "x-example": "00001111-aaaa-2222-bbbb-3333cccc4444" + "example": "00001111-aaaa-2222-bbbb-3333cccc4444" }, "applicationSecret": { "type": "string", "description": "Microsoft OAuth2 application secret.", - "x-example": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u" + "example": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u" }, "tenant": { "type": "string", "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID.", - "x-example": "common" + "example": "common" } }, "required": [ @@ -108333,8 +108211,8 @@ "total": { "type": "integer", "description": "Total number of OAuth2 providers in the given project.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "providers": { "type": "array", @@ -108513,8 +108391,7 @@ "microsoft": "#\/components\/schemas\/oAuth2Microsoft" } } - }, - "x-example": "" + } } }, "required": [ @@ -108533,12 +108410,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether password dictionary policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -108557,13 +108434,13 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "total": { "type": "integer", "description": "Password history length. A value of 0 means the policy is disabled.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 } }, "required": [ @@ -108582,33 +108459,33 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "min": { "type": "integer", "description": "Minimum password length required for user passwords.", - "x-example": 12, - "format": "int32" + "format": "int32", + "example": 12 }, "uppercase": { "type": "boolean", "description": "Whether passwords must include at least one uppercase letter.", - "x-example": true + "example": true }, "lowercase": { "type": "boolean", "description": "Whether passwords must include at least one lowercase letter.", - "x-example": true + "example": true }, "number": { "type": "boolean", "description": "Whether passwords must include at least one number.", - "x-example": true + "example": true }, "symbols": { "type": "boolean", "description": "Whether passwords must include at least one symbol.", - "x-example": true + "example": true } }, "required": [ @@ -108635,12 +108512,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether password personal data policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -108659,12 +108536,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether session alert policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -108683,13 +108560,13 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "duration": { "type": "integer", "description": "Session duration in seconds.", - "x-example": 3600, - "format": "int32" + "format": "int32", + "example": 3600 } }, "required": [ @@ -108708,12 +108585,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether session invalidation policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -108732,13 +108609,13 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "total": { "type": "integer", "description": "Maximum number of sessions allowed per user. A value of 0 means the policy is disabled.", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 } }, "required": [ @@ -108757,13 +108634,13 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "total": { "type": "integer", "description": "Maximum number of users allowed in the project. A value of 0 means the policy is disabled.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 } }, "required": [ @@ -108782,37 +108659,37 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "userId": { "type": "boolean", "description": "Whether user ID is visible in memberships.", - "x-example": true + "example": true }, "userEmail": { "type": "boolean", "description": "Whether user email is visible in memberships.", - "x-example": true + "example": true }, "userPhone": { "type": "boolean", "description": "Whether user phone is visible in memberships.", - "x-example": true + "example": true }, "userName": { "type": "boolean", "description": "Whether user name is visible in memberships.", - "x-example": true + "example": true }, "userMFA": { "type": "boolean", "description": "Whether user MFA status is visible in memberships.", - "x-example": true + "example": true }, "userAccessedAt": { "type": "boolean", "description": "Whether user last access time is visible in memberships.", - "x-example": true + "example": true } }, "required": [ @@ -108841,27 +108718,27 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "totp": { "type": "boolean", "description": "Whether TOTP can be used to complete an MFA challenge.", - "x-example": true + "example": true }, "email": { "type": "boolean", "description": "Whether email can be used to complete an MFA challenge.", - "x-example": true + "example": true }, "phone": { "type": "boolean", "description": "Whether phone (SMS) can be used to complete an MFA challenge.", - "x-example": true + "example": true }, "custom": { "type": "boolean", "description": "Whether the custom factor can be used to complete an MFA challenge.", - "x-example": true + "example": true } }, "required": [ @@ -108886,27 +108763,27 @@ "$id": { "type": "string", "description": "Platform ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Platform name.", - "x-example": "My Web App" + "example": "My Web App" }, "type": { "type": "string", "description": "Platform type. Possible values are: windows, apple, android, linux, web.", - "x-example": "web", + "example": "web", "enum": [ "windows", "apple", @@ -108919,7 +108796,7 @@ "hostname": { "type": "string", "description": "Web app hostname. Empty string for other platforms.", - "x-example": "app.example.com" + "example": "app.example.com" } }, "required": [ @@ -108947,27 +108824,27 @@ "$id": { "type": "string", "description": "Platform ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Platform name.", - "x-example": "My Web App" + "example": "My Web App" }, "type": { "type": "string", "description": "Platform type. Possible values are: windows, apple, android, linux, web.", - "x-example": "web", + "example": "web", "enum": [ "windows", "apple", @@ -108980,7 +108857,7 @@ "bundleIdentifier": { "type": "string", "description": "Apple bundle identifier.", - "x-example": "com.company.appname" + "example": "com.company.appname" } }, "required": [ @@ -109007,27 +108884,27 @@ "$id": { "type": "string", "description": "Platform ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Platform name.", - "x-example": "My Web App" + "example": "My Web App" }, "type": { "type": "string", "description": "Platform type. Possible values are: windows, apple, android, linux, web.", - "x-example": "web", + "example": "web", "enum": [ "windows", "apple", @@ -109040,7 +108917,7 @@ "applicationId": { "type": "string", "description": "Android application ID.", - "x-example": "com.company.appname" + "example": "com.company.appname" } }, "required": [ @@ -109067,27 +108944,27 @@ "$id": { "type": "string", "description": "Platform ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Platform name.", - "x-example": "My Web App" + "example": "My Web App" }, "type": { "type": "string", "description": "Platform type. Possible values are: windows, apple, android, linux, web.", - "x-example": "web", + "example": "web", "enum": [ "windows", "apple", @@ -109100,7 +108977,7 @@ "packageIdentifierName": { "type": "string", "description": "Windows package identifier name.", - "x-example": "com.company.appname" + "example": "com.company.appname" } }, "required": [ @@ -109127,27 +109004,27 @@ "$id": { "type": "string", "description": "Platform ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Platform name.", - "x-example": "My Web App" + "example": "My Web App" }, "type": { "type": "string", "description": "Platform type. Possible values are: windows, apple, android, linux, web.", - "x-example": "web", + "example": "web", "enum": [ "windows", "apple", @@ -109160,7 +109037,7 @@ "packageName": { "type": "string", "description": "Linux package name.", - "x-example": "com.company.appname" + "example": "com.company.appname" } }, "required": [ @@ -109187,8 +109064,8 @@ "total": { "type": "integer", "description": "Total number of platforms in the given project.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "platforms": { "type": "array", @@ -109221,8 +109098,7 @@ "linux": "#\/components\/schemas\/platformLinux" } } - }, - "x-example": "" + } } }, "required": [ @@ -109241,42 +109117,42 @@ "$id": { "type": "string", "description": "Variable ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Variable creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Variable creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "key": { "type": "string", "description": "Variable key.", - "x-example": "API_KEY" + "example": "API_KEY" }, "value": { "type": "string", "description": "Variable value.", - "x-example": "myPa$$word1" + "example": "myPa$$word1" }, "secret": { "type": "boolean", "description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.", - "x-example": false + "example": false }, "resourceType": { "type": "string", "description": "Service to which the variable belongs. Possible values are \"project\", \"function\"", - "x-example": "function" + "example": "function" }, "resourceId": { "type": "string", "description": "ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.", - "x-example": "myAwesomeFunction" + "example": "myAwesomeFunction" } }, "required": [ @@ -109307,12 +109183,12 @@ "name": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" }, "code": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" } }, "required": [ @@ -109331,12 +109207,12 @@ "name": { "type": "string", "description": "Continent name.", - "x-example": "Europe" + "example": "Europe" }, "code": { "type": "string", "description": "Continent two letter code.", - "x-example": "EU" + "example": "EU" } }, "required": [ @@ -109355,17 +109231,17 @@ "name": { "type": "string", "description": "Language name.", - "x-example": "Italian" + "example": "Italian" }, "code": { "type": "string", "description": "Language two-character ISO 639-1 codes.", - "x-example": "it" + "example": "it" }, "nativeName": { "type": "string", "description": "Language native name.", - "x-example": "Italiano" + "example": "Italiano" } }, "required": [ @@ -109386,39 +109262,39 @@ "symbol": { "type": "string", "description": "Currency symbol.", - "x-example": "$" + "example": "$" }, "name": { "type": "string", "description": "Currency name.", - "x-example": "US dollar" + "example": "US dollar" }, "symbolNative": { "type": "string", "description": "Currency native symbol.", - "x-example": "$" + "example": "$" }, "decimalDigits": { "type": "integer", "description": "Number of decimal digits.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "rounding": { "type": "number", "description": "Currency digit rounding.", - "x-example": 0, - "format": "double" + "format": "double", + "example": 0 }, "code": { "type": "string", "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.", - "x-example": "USD" + "example": "USD" }, "namePlural": { "type": "string", "description": "Currency plural name", - "x-example": "US dollars" + "example": "US dollars" } }, "required": [ @@ -109447,17 +109323,17 @@ "code": { "type": "string", "description": "Phone code.", - "x-example": "+1" + "example": "+1" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" }, "countryName": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" } }, "required": [ @@ -109478,13 +109354,13 @@ "value": { "type": "integer", "description": "The value of this metric at the timestamp.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "date": { "type": "string", "description": "The date at which this metric was aggregated in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -109503,25 +109379,25 @@ "resourceId": { "type": "string", "description": "Resource ID.", - "x-example": "5e5ea5c16897e", + "example": "5e5ea5c16897e", "nullable": true }, "name": { "type": "string", "description": "Resource name.", - "x-example": "Documents" + "example": "Documents" }, "value": { "type": "integer", "description": "The value of this metric at the timestamp.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "estimate": { "type": "number", "description": "The estimated value of this metric at the end of the period.", - "x-example": 1, "format": "double", + "example": 1, "nullable": true } }, @@ -109543,19 +109419,19 @@ "range": { "type": "string", "description": "Time range of the usage stats.", - "x-example": "30d" + "example": "30d" }, "usersTotal": { "type": "integer", "description": "Total aggregated number of statistics of users.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "sessionsTotal": { "type": "integer", "description": "Total aggregated number of active sessions.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "users": { "type": "array", @@ -109563,7 +109439,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "sessions": { "type": "array", @@ -109571,7 +109447,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] } }, "required": [ @@ -109596,13 +109472,13 @@ "range": { "type": "string", "description": "Time range of the usage stats.", - "x-example": "30d" + "example": "30d" }, "usersOnlineTotal": { "type": "integer", "description": "Current total number of online users.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "presences": { "type": "array", @@ -109610,7 +109486,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] } }, "required": [ @@ -109631,122 +109507,122 @@ "executionsTotal": { "type": "integer", "description": "Total aggregated number of function executions.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "documentsTotal": { "type": "integer", "description": "Total aggregated number of documents in legacy\/tablesdb.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "documentsdbDocumentsTotal": { "type": "integer", "description": "Total aggregated number of documents in documentsdb.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "rowsTotal": { "type": "integer", "description": "Total aggregated number of rows.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "databasesTotal": { "type": "integer", "description": "Total aggregated number of databases.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "documentsdbTotal": { "type": "integer", "description": "Total aggregated number of documentsdb.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "databasesStorageTotal": { "type": "integer", "description": "Total aggregated sum of databases storage size (in bytes).", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "documentsdbDatabasesStorageTotal": { "type": "integer", "description": "Total aggregated sum of documentsdb databases storage size (in bytes).", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "usersTotal": { "type": "integer", "description": "Total aggregated number of users.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "filesStorageTotal": { "type": "integer", "description": "Total aggregated sum of files storage size (in bytes).", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "functionsStorageTotal": { "type": "integer", "description": "Total aggregated sum of functions storage size (in bytes).", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "buildsStorageTotal": { "type": "integer", "description": "Total aggregated sum of builds storage size (in bytes).", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "deploymentsStorageTotal": { "type": "integer", "description": "Total aggregated sum of deployments storage size (in bytes).", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "bucketsTotal": { "type": "integer", "description": "Total aggregated number of buckets.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "executionsMbSecondsTotal": { "type": "integer", "description": "Total aggregated number of function executions mbSeconds.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "buildsMbSecondsTotal": { "type": "integer", "description": "Total aggregated number of function builds mbSeconds.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "databasesReadsTotal": { "type": "integer", "description": "Aggregated stats for total databases reads.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "databasesWritesTotal": { "type": "integer", "description": "Aggregated stats for total databases writes.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "documentsdbDatabasesReadsTotal": { "type": "integer", "description": "Total number of documentsdb databases reads.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "documentsdbDatabasesWritesTotal": { "type": "integer", "description": "Total number of documentsdb databases writes.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "requests": { "type": "array", @@ -109754,7 +109630,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "network": { "type": "array", @@ -109762,7 +109638,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "users": { "type": "array", @@ -109770,7 +109646,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "executions": { "type": "array", @@ -109778,19 +109654,19 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "authPhoneTotal": { "type": "integer", "description": "Aggregated stats for total auth phone.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "authPhoneEstimate": { "type": "integer", "description": "Aggregated stats for total auth phone estimation.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "authPhoneCountryBreakdown": { "type": "array", @@ -109798,7 +109674,7 @@ "items": { "$ref": "#\/components\/schemas\/metricBreakdown" }, - "x-example": [] + "example": [] }, "databasesReads": { "type": "array", @@ -109806,7 +109682,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "databasesWrites": { "type": "array", @@ -109814,7 +109690,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "documentsdbDatabasesReads": { "type": "array", @@ -109822,7 +109698,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "documentsdbDatabasesWrites": { "type": "array", @@ -109830,7 +109706,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "documentsdbDatabasesStorage": { "type": "array", @@ -109838,7 +109714,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "imageTransformations": { "type": "array", @@ -109846,49 +109722,49 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "imageTransformationsTotal": { "type": "integer", "description": "Total aggregated number of image transformations.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "vectorsdbDatabasesTotal": { "type": "integer", "description": "Total aggregated number of VectorsDB databases.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "vectorsdbCollectionsTotal": { "type": "integer", "description": "Total aggregated number of VectorsDB collections.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "vectorsdbDocumentsTotal": { "type": "integer", "description": "Total aggregated number of VectorsDB documents.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "vectorsdbDatabasesStorageTotal": { "type": "integer", "description": "Total aggregated VectorsDB storage (bytes).", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "vectorsdbDatabasesReadsTotal": { "type": "integer", "description": "Total aggregated number of VectorsDB reads.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "vectorsdbDatabasesWritesTotal": { "type": "integer", "description": "Total aggregated number of VectorsDB writes.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "vectorsdbDatabases": { "type": "array", @@ -109896,7 +109772,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "vectorsdbCollections": { "type": "array", @@ -109904,7 +109780,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "vectorsdbDocuments": { "type": "array", @@ -109912,7 +109788,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "vectorsdbDatabasesStorage": { "type": "array", @@ -109920,7 +109796,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "vectorsdbDatabasesReads": { "type": "array", @@ -109928,7 +109804,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "vectorsdbDatabasesWrites": { "type": "array", @@ -109936,7 +109812,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "embeddingsText": { "type": "array", @@ -109944,7 +109820,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "embeddingsTextTokens": { "type": "array", @@ -109952,7 +109828,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "embeddingsTextDuration": { "type": "array", @@ -109960,7 +109836,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "embeddingsTextErrors": { "type": "array", @@ -109968,31 +109844,31 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "embeddingsTextTotal": { "type": "integer", "description": "Total aggregated number of text embedding calls.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "embeddingsTextTokensTotal": { "type": "integer", "description": "Total aggregated number of tokens processed by text.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "embeddingsTextDurationTotal": { "type": "integer", "description": "Total aggregated duration spent generating text embeddings.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "embeddingsTextErrorsTotal": { "type": "integer", "description": "Total aggregated number of errors while generating text embeddings.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "functionsExecutions": { "type": "array", @@ -110000,13 +109876,13 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "functionsExecutionsTotal": { "type": "integer", "description": "Total aggregated number of function executions.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "sitesExecutions": { "type": "array", @@ -110014,25 +109890,25 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "sitesExecutionsTotal": { "type": "integer", "description": "Total aggregated number of site executions.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "networkTotal": { "type": "integer", "description": "Aggregated stats for total network bandwidth.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "backupsStorageTotal": { "type": "integer", "description": "Aggregated stats for total backups storage.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "screenshotsGenerated": { "type": "array", @@ -110040,31 +109916,31 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "screenshotsGeneratedTotal": { "type": "integer", "description": "Total aggregated number of screenshots generated.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "realtimeConnectionsTotal": { "type": "integer", "description": "Current aggregated number of open Realtime connections.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "realtimeMessagesTotal": { "type": "integer", "description": "Total number of Realtime messages sent to clients.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "realtimeBandwidthTotal": { "type": "integer", "description": "Total consumed Realtime bandwidth (in bytes).", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "realtimeConnections": { "type": "array", @@ -110072,7 +109948,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "realtimeMessages": { "type": "array", @@ -110080,7 +109956,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "realtimeBandwidth": { "type": "array", @@ -110088,7 +109964,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] } }, "required": [ @@ -110239,12 +110115,12 @@ "name": { "type": "string", "description": "Header name.", - "x-example": "Content-Type" + "example": "Content-Type" }, "value": { "type": "string", "description": "Header value.", - "x-example": "application\/json" + "example": "application\/json" } }, "required": [ @@ -110263,24 +110139,24 @@ "memory": { "type": "integer", "description": "Memory size in MB.", - "x-example": 512, - "format": "int32" + "format": "int32", + "example": 512 }, "cpus": { "type": "number", "description": "Number of CPUs.", - "x-example": 1, - "format": "double" + "format": "double", + "example": 1 }, "enabled": { "type": "boolean", "description": "Is size enabled.", - "x-example": true + "example": true }, "slug": { "type": "string", "description": "Size slug.", - "x-example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb" } }, "required": [ @@ -110303,53 +110179,53 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Rule creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Rule update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "domain": { "type": "string", "description": "Domain name.", - "x-example": "appwrite.company.com" + "example": "appwrite.company.com" }, "type": { "type": "string", "description": "Action definition for the rule. Possible values are \"api\", \"deployment\", or \"redirect\"", - "x-example": "deployment" + "example": "deployment" }, "trigger": { "type": "string", "description": "Defines how the rule was created. Possible values are \"manual\" or \"deployment\"", - "x-example": "manual" + "example": "manual" }, "redirectUrl": { "type": "string", "description": "URL to redirect to. Used if type is \"redirect\"", - "x-example": "https:\/\/appwrite.io\/docs" + "example": "https:\/\/appwrite.io\/docs" }, "redirectStatusCode": { "type": "integer", "description": "Status code to apply during redirect. Used if type is \"redirect\"", - "x-example": 301, - "format": "int32" + "format": "int32", + "example": 301 }, "deploymentId": { "type": "string", "description": "ID of deployment. Used if type is \"deployment\"", - "x-example": "n3u9feiwmf" + "example": "n3u9feiwmf" }, "deploymentResourceType": { "type": "string", "description": "Type of deployment. Possible values are \"function\", \"site\". Used if rule's type is \"deployment\".", - "x-example": "function", + "example": "function", "enum": [ "function", "site" @@ -110359,17 +110235,17 @@ "deploymentResourceId": { "type": "string", "description": "ID of deployment's resource (site or function ID). Used if type is \"deployment\"", - "x-example": "n3u9feiwmf" + "example": "n3u9feiwmf" }, "deploymentVcsProviderBranch": { "type": "string", "description": "Name of Git branch that updates rule. Used if type is \"deployment\"", - "x-example": "main" + "example": "main" }, "status": { "type": "string", "description": "Domain verification status. Possible values are \"unverified\", \"verifying\", \"verified\"", - "x-example": "verified", + "example": "verified", "enum": [ "unverified", "verifying", @@ -110379,12 +110255,12 @@ "logs": { "type": "string", "description": "Logs from rule verification or certificate generation. Certificate generation logs are prioritized if both are available.", - "x-example": "Verification of DNS records failed with DNS resolver 8.8.8.8. Domain stage.myapp.com does not have DNS record." + "example": "Verification of DNS records failed with DNS resolver 8.8.8.8. Domain stage.myapp.com does not have DNS record." }, "renewAt": { "type": "string", "description": "Certificate auto-renewal date in ISO 8601 format.", - "x-example": "datetime" + "example": "datetime" } }, "required": [ @@ -110428,58 +110304,58 @@ "$id": { "type": "string", "description": "Schedule ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Schedule creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Schedule update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "resourceType": { "type": "string", "description": "The resource type associated with this schedule.", - "x-example": "function" + "example": "function" }, "resourceId": { "type": "string", "description": "The resource ID associated with this schedule.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "resourceUpdatedAt": { "type": "string", "description": "Change-tracking timestamp used by the scheduler to detect resource changes in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "projectId": { "type": "string", "description": "The project ID associated with this schedule.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "schedule": { "type": "string", "description": "The CRON schedule expression.", - "x-example": "5 4 * * *" + "example": "5 4 * * *" }, "data": { "type": "object", "additionalProperties": true, "description": "Schedule data used to store resource-specific context needed for execution.", - "x-example": [] + "example": {} }, "active": { "type": "boolean", "description": "Whether the schedule is active.", - "x-example": true + "example": true }, "region": { "type": "string", "description": "The region where the schedule is deployed.", - "x-example": "fra" + "example": "fra" } }, "required": [ @@ -110516,27 +110392,27 @@ "id": { "type": "string", "description": "Stage ID.", - "x-example": "tablesDB.create" + "example": "tablesDB.create" }, "sdk": { "type": "string", "description": "SDK method key (namespace.name) for this stage.", - "x-example": "tablesDB.create" + "example": "tablesDB.create" }, "status": { "type": "string", "description": "Stage status.", - "x-example": "completed" + "example": "completed" }, "at": { "type": "string", "description": "When the stage was completed or skipped, in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "actorType": { "type": "string", "description": "Actor type when the stage was recorded.", - "x-example": "user" + "example": "user" } }, "required": [ @@ -110561,42 +110437,42 @@ "templateId": { "type": "string", "description": "Template type", - "x-example": "verification" + "example": "verification" }, "locale": { "type": "string", "description": "Template locale", - "x-example": "en_us" + "example": "en_us" }, "message": { "type": "string", "description": "Template message", - "x-example": "Click on the link to verify your account." + "example": "Click on the link to verify your account." }, "senderName": { "type": "string", "description": "Name of the sender", - "x-example": "My User" + "example": "My User" }, "senderEmail": { "type": "string", "description": "Email of the sender", - "x-example": "mail@appwrite.io" + "example": "mail@appwrite.io" }, "replyToEmail": { "type": "string", "description": "Reply to email address", - "x-example": "emails@appwrite.io" + "example": "emails@appwrite.io" }, "replyToName": { "type": "string", "description": "Reply to name", - "x-example": "Support Team" + "example": "Support Team" }, "subject": { "type": "string", "description": "Email subject", - "x-example": "Please verify your email address" + "example": "Please verify your email address" } }, "required": [ @@ -110627,50 +110503,50 @@ "_APP_DOMAIN_TARGET_CNAME": { "type": "string", "description": "CNAME target for your Appwrite custom domains.", - "x-example": "appwrite.io" + "example": "appwrite.io" }, "_APP_DOMAIN_TARGET_A": { "type": "string", "description": "A target for your Appwrite custom domains.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "_APP_COMPUTE_BUILD_TIMEOUT": { "type": "integer", "description": "Maximum build timeout in seconds.", - "x-example": 900, - "format": "int32" + "format": "int32", + "example": 900 }, "_APP_DOMAIN_TARGET_AAAA": { "type": "string", "description": "AAAA target for your Appwrite custom domains.", - "x-example": "::1" + "example": "::1" }, "_APP_DOMAIN_TARGET_CAA": { "type": "string", "description": "CAA target for your Appwrite custom domains.", - "x-example": "digicert.com" + "example": "digicert.com" }, "_APP_STORAGE_LIMIT": { "type": "integer", "description": "Maximum file size allowed for file upload in bytes.", - "x-example": "30000000", - "format": "int32" + "format": "int32", + "example": 30000000 }, "_APP_COMPUTE_SIZE_LIMIT": { "type": "integer", "description": "Maximum file size allowed for deployment in bytes.", - "x-example": "30000000", - "format": "int32" + "format": "int32", + "example": 30000000 }, "_APP_USAGE_STATS": { "type": "string", "description": "Defines if usage stats are enabled. This value is set to 'enabled' by default, to disable the usage stats set the value to 'disabled'.", - "x-example": "enabled" + "example": "enabled" }, "_APP_VCS_ENABLED": { "type": "boolean", "description": "Defines if VCS (Version Control System) is enabled.", - "x-example": true + "example": true }, "_APP_VCS_PROVIDERS": { "type": "array", @@ -110678,100 +110554,100 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "github" ] }, "_APP_DOMAIN_ENABLED": { "type": "boolean", "description": "Defines if main domain is configured. If so, custom domains can be created.", - "x-example": true + "example": true }, "_APP_ASSISTANT_ENABLED": { "type": "boolean", "description": "Defines if AI assistant is enabled.", - "x-example": true + "example": true }, "_APP_DOMAIN_SITES": { "type": "string", "description": "A comma separated list of domains to use for site URLs.", - "x-example": "sites.localhost,sites.example.com" + "example": "sites.localhost,sites.example.com" }, "_APP_DOMAIN_FUNCTIONS": { "type": "string", "description": "A domain to use for function URLs.", - "x-example": "functions.localhost" + "example": "functions.localhost" }, "_APP_OPTIONS_FORCE_HTTPS": { "type": "string", "description": "Defines if HTTPS is enforced for all requests.", - "x-example": "enabled" + "example": "enabled" }, "_APP_DOMAINS_NAMESERVERS": { "type": "string", "description": "Comma-separated list of nameservers.", - "x-example": "ns1.example.com,ns2.example.com" + "example": "ns1.example.com,ns2.example.com" }, "_APP_DB_ADAPTER": { "type": "string", "description": "Database adapter in use.", - "x-example": "mysql" + "example": "mysql" }, "supportForRelationships": { "type": "boolean", "description": "Whether the database adapter supports relationships.", - "x-example": true + "example": true }, "supportForOperators": { "type": "boolean", "description": "Whether the database adapter supports operators.", - "x-example": true + "example": true }, "supportForSpatials": { "type": "boolean", "description": "Whether the database adapter supports spatial attributes.", - "x-example": true + "example": true }, "supportForSpatialIndexNull": { "type": "boolean", "description": "Whether the database adapter supports spatial indexes on nullable columns.", - "x-example": false + "example": false }, "supportForFulltextWildcard": { "type": "boolean", "description": "Whether the database adapter supports fulltext wildcard search.", - "x-example": true + "example": true }, "supportForMultipleFulltextIndexes": { "type": "boolean", "description": "Whether the database adapter supports multiple fulltext indexes per collection.", - "x-example": true + "example": true }, "supportForAttributeResizing": { "type": "boolean", "description": "Whether the database adapter supports resizing attributes.", - "x-example": true + "example": true }, "supportForSchemas": { "type": "boolean", "description": "Whether the database adapter supports fixed schemas with row width limits.", - "x-example": true + "example": true }, "maxIndexLength": { "type": "integer", "description": "Maximum index length supported by the database adapter.", - "x-example": 768, - "format": "int32" + "format": "int32", + "example": 768 }, "supportForIntegerIds": { "type": "boolean", "description": "Whether the database adapter uses integer sequence IDs.", - "x-example": true + "example": true }, "_APP_CONSOLE_EMAIL_VERIFICATION": { "type": "string", "description": "Whether email verification for console users is required. Can be \"true\" or \"false\".", - "x-example": "true" + "example": "true" } }, "required": [ @@ -110844,22 +110720,22 @@ "$id": { "type": "string", "description": "Parameter ID. Maps to the request body field used by the project OAuth2 update endpoint (e.g. `clientId`, `appKey`, `tenant`).", - "x-example": "clientId" + "example": "clientId" }, "name": { "type": "string", "description": "Verbose, user-facing parameter name as shown in the provider's own dashboard. Includes alternate names when the provider exposes more than one.", - "x-example": "Client ID or App ID" + "example": "Client ID or App ID" }, "example": { "type": "string", "description": "Example value for this parameter.", - "x-example": "e4d87900000000540733" + "example": "e4d87900000000540733" }, "hint": { "type": "string", "description": "Optional hint for this parameter, typically calling out a common wrong value. Empty string when no hint is set.", - "x-example": "Example of wrong value: 370006" + "example": "Example of wrong value: 370006" } }, "required": [ @@ -110882,15 +110758,14 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "parameters": { "type": "array", "description": "List of parameters required to configure this OAuth2 provider.", "items": { "$ref": "#\/components\/schemas\/consoleOAuth2ProviderParameter" - }, - "x-example": "" + } } }, "required": [ @@ -110909,16 +110784,15 @@ "total": { "type": "integer", "description": "Total number of OAuth2 providers exposed by the server.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "oAuth2Providers": { "type": "array", "description": "List of OAuth2 providers, each with the parameters required to configure it.", "items": { "$ref": "#\/components\/schemas\/consoleOAuth2Provider" - }, - "x-example": "" + } } }, "required": [ @@ -110937,22 +110811,22 @@ "$id": { "type": "string", "description": "Scope ID.", - "x-example": "users.read" + "example": "users.read" }, "description": { "type": "string", "description": "Scope description.", - "x-example": "Access to read your project's users" + "example": "Access to read your project's users" }, "category": { "type": "string", "description": "Scope category.", - "x-example": "Auth" + "example": "Auth" }, "deprecated": { "type": "boolean", "description": "Scope is deprecated.", - "x-example": true + "example": true } }, "required": [ @@ -110975,16 +110849,15 @@ "total": { "type": "integer", "description": "Total number of key scopes exposed by the server.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "scopes": { "type": "array", "description": "List of key scopes, each with its ID and description.", "items": { "$ref": "#\/components\/schemas\/consoleKeyScope" - }, - "x-example": "" + } } }, "required": [ @@ -111003,22 +110876,22 @@ "$id": { "type": "string", "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -111041,27 +110914,27 @@ "$id": { "type": "string", "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "code": { "type": "string", "description": "Challenge code to be delivered to the end user through a custom channel.", - "x-example": "446372" + "example": "446372" } }, "required": [ @@ -111089,7 +110962,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "a3kf0-s0cl2", "s0co1-as98s" ] @@ -111112,12 +110985,12 @@ "secret": { "type": "string", "description": "Secret token used for TOTP factor.", - "x-example": "[SHARED_SECRET]" + "example": "[SHARED_SECRET]" }, "uri": { "type": "string", "description": "URI for authenticator apps.", - "x-example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" + "example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" } }, "required": [ @@ -111136,27 +111009,27 @@ "totp": { "type": "boolean", "description": "Can TOTP be used for MFA challenge for this account.", - "x-example": true + "example": true }, "phone": { "type": "boolean", "description": "Can phone (SMS) be used for MFA challenge for this account.", - "x-example": true + "example": true }, "email": { "type": "boolean", "description": "Can email be used for MFA challenge for this account.", - "x-example": true + "example": true }, "recoveryCode": { "type": "boolean", "description": "Can recovery code be used for MFA challenge for this account.", - "x-example": true + "example": true }, "custom": { "type": "boolean", "description": "Can custom factor be used for MFA challenge for this account.", - "x-example": true + "example": true } }, "required": [ @@ -111181,43 +111054,43 @@ "$id": { "type": "string", "description": "Provider ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Provider creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Provider update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "The name for the provider instance.", - "x-example": "Mailgun" + "example": "Mailgun" }, "provider": { "type": "string", "description": "The name of the provider service.", - "x-example": "mailgun" + "example": "mailgun" }, "enabled": { "type": "boolean", "description": "Is provider enabled?", - "x-example": true + "example": true }, "type": { "type": "string", "description": "Type of provider.", - "x-example": "sms" + "example": "sms" }, "credentials": { "type": "object", "additionalProperties": true, "description": "Provider credentials.", - "x-example": { + "example": { "key": "123456789" } }, @@ -111225,7 +111098,7 @@ "type": "object", "additionalProperties": true, "description": "Provider options.", - "x-example": { + "example": { "from": "sender-email@mydomain" } } @@ -111263,22 +111136,22 @@ "$id": { "type": "string", "description": "Message ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Message creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Message update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "providerType": { "type": "string", "description": "Message provider type.", - "x-example": "email" + "example": "email" }, "topics": { "type": "array", @@ -111286,7 +111159,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "5e5ea5c16897e" ] }, @@ -111296,7 +111169,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "5e5ea5c16897e" ] }, @@ -111306,20 +111179,20 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "5e5ea5c16897e" ] }, "scheduledAt": { "type": "string", "description": "The scheduled time for message.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "deliveredAt": { "type": "string", "description": "The time when the message was delivered.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "deliveryErrors": { @@ -111328,7 +111201,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "Failed to send message to target 5e5ea5c16897e: Credentials not valid." ], "nullable": true @@ -111336,14 +111209,14 @@ "deliveredTotal": { "type": "integer", "description": "Number of recipients the message was delivered to.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "data": { "type": "object", "additionalProperties": true, "description": "Data of the message.", - "x-example": { + "example": { "subject": "Welcome to Appwrite", "content": "Hi there, welcome to Appwrite family." } @@ -111351,7 +111224,7 @@ "status": { "type": "string", "description": "Status of delivery.", - "x-example": "processing", + "example": "processing", "enum": [ "draft", "processing", @@ -111407,40 +111280,40 @@ "$id": { "type": "string", "description": "Topic ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Topic creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Topic update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "The name of the topic.", - "x-example": "events" + "example": "events" }, "emailTotal": { "type": "integer", "description": "Total count of email subscribers subscribed to the topic.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "smsTotal": { "type": "integer", "description": "Total count of SMS subscribers subscribed to the topic.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "pushTotal": { "type": "integer", "description": "Total count of push subscribers subscribed to the topic.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "subscribe": { "type": "array", @@ -111448,7 +111321,9 @@ "items": { "type": "string" }, - "x-example": "users" + "example": [ + "users" + ] } }, "required": [ @@ -111479,33 +111354,33 @@ "$id": { "type": "string", "description": "Transaction ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Transaction creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Transaction update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "status": { "type": "string", "description": "Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.", - "x-example": "pending" + "example": "pending" }, "operations": { "type": "integer", "description": "Number of operations in the transaction.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "expiresAt": { "type": "string", "description": "Expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -111532,27 +111407,27 @@ "$id": { "type": "string", "description": "Subscriber ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Subscriber creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Subscriber update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "targetId": { "type": "string", "description": "Target ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "target": { "type": "object", "description": "Target.", - "x-example": { + "example": { "$id": "259125845563242502", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", @@ -111571,22 +111446,22 @@ "userId": { "type": "string", "description": "Topic ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userName": { "type": "string", "description": "User Name.", - "x-example": "Aegon Targaryen" + "example": "Aegon Targaryen" }, "topicId": { "type": "string", "description": "Topic ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "providerType": { "type": "string", "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email" + "example": "email" } }, "required": [ @@ -111628,48 +111503,48 @@ "$id": { "type": "string", "description": "Target ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Target creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Target update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Target Name.", - "x-example": "Apple iPhone 12" + "example": "Apple iPhone 12" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "providerId": { "type": "string", "description": "Provider ID.", - "x-example": "259125845563242502", + "example": "259125845563242502", "nullable": true }, "providerType": { "type": "string", "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email" + "example": "email" }, "identifier": { "type": "string", "description": "The target identifier.", - "x-example": "token" + "example": "token" }, "expired": { "type": "boolean", "description": "Is the target expired.", - "x-example": false + "example": false } }, "required": [ @@ -111701,37 +111576,37 @@ "$id": { "type": "string", "description": "Migration ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Migration creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Variable creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "status": { "type": "string", "description": "Migration status ( pending, processing, failed, completed ) ", - "x-example": "pending" + "example": "pending" }, "stage": { "type": "string", "description": "Migration stage ( init, processing, source-check, destination-check, migrating, finished )", - "x-example": "init" + "example": "init" }, "source": { "type": "string", "description": "A string containing the type of source of the migration.", - "x-example": "Appwrite" + "example": "Appwrite" }, "destination": { "type": "string", "description": "A string containing the type of destination of the migration.", - "x-example": "Appwrite" + "example": "Appwrite" }, "resources": { "type": "array", @@ -111739,66 +111614,84 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "user" ] }, "resourceId": { "type": "string", "description": "ID of the resource being migrated.", - "x-example": "collectionId" + "example": "collectionId" }, "resourceInternalId": { "type": "string", "description": "Internal ID of the resource being migrated.", - "x-example": "1" + "example": "1" }, "resourceType": { "type": "string", "description": "Type of the resource being migrated.", - "x-example": "collection" + "example": "collection" }, "parentResourceId": { "type": "string", "description": "ID of the parent resource that contains the migrated resource.", - "x-example": "databaseId" + "example": "databaseId" }, "parentResourceInternalId": { "type": "string", "description": "Internal ID of the parent resource that contains the migrated resource.", - "x-example": "1" + "example": "1" }, "parentResourceType": { "type": "string", "description": "Type of the parent resource that contains the migrated resource.", - "x-example": "database" + "example": "database" }, "destinationResourceId": { "type": "string", "description": "ID of the destination resource created or overwritten by the migration.", - "x-example": "databaseId" + "example": "databaseId" }, "destinationResourceInternalId": { "type": "string", "description": "Internal ID of the destination resource created or overwritten by the migration.", - "x-example": "1" + "example": "1" }, "destinationResourceType": { "type": "string", "description": "Type of the destination resource created or overwritten by the migration.", - "x-example": "database" + "example": "database" }, "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}}" + "example": { + "Database": { + "PENDING": 0, + "SUCCESS": 1, + "ERROR": 0, + "SKIP": 0, + "PROCESSING": 0, + "WARNING": 0 + } + } }, "resourceData": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "An array of objects containing the report data of the resources that were migrated.", - "x-example": "[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]" + "items": { + "type": "object" + }, + "example": [ + { + "resource": "Database", + "id": "public", + "status": "SUCCESS", + "message": "" + } + ] }, "errors": { "type": "array", @@ -111806,13 +111699,16 @@ "items": { "type": "string" }, - "x-example": [] + "example": [] }, "options": { "type": "object", "additionalProperties": true, "description": "Migration options used during the migration process.", - "x-example": "{\"bucketId\": \"exports\", \"notify\": false}" + "example": { + "bucketId": "exports", + "notify": false + } } }, "required": [ @@ -111871,169 +111767,169 @@ "user": { "type": "integer", "description": "Number of users to be migrated.", - "x-example": 20, - "format": "int32" + "format": "int32", + "example": 20 }, "team": { "type": "integer", "description": "Number of teams to be migrated.", - "x-example": 20, - "format": "int32" + "format": "int32", + "example": 20 }, "database": { "type": "integer", "description": "Number of databases to be migrated.", - "x-example": 20, - "format": "int32" + "format": "int32", + "example": 20 }, "row": { "type": "integer", "description": "Number of rows to be migrated.", - "x-example": 20, - "format": "int32" + "format": "int32", + "example": 20 }, "file": { "type": "integer", "description": "Number of files to be migrated.", - "x-example": 20, - "format": "int32" + "format": "int32", + "example": 20 }, "bucket": { "type": "integer", "description": "Number of buckets to be migrated.", - "x-example": 20, - "format": "int32" + "format": "int32", + "example": 20 }, "function": { "type": "integer", "description": "Number of functions to be migrated.", - "x-example": 20, - "format": "int32" + "format": "int32", + "example": 20 }, "platform": { "type": "integer", "description": "Number of platforms to be migrated.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "api-key": { "type": "integer", "description": "Number of API keys to be migrated.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "project-variable": { "type": "integer", "description": "Number of project variables to be migrated.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "webhook": { "type": "integer", "description": "Number of webhooks to be migrated.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "auth-methods": { "type": "integer", "description": "Number of auth-method configs to be migrated (always 0 or 1 \u2014 the project-level flag bundle).", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "project-protocols": { "type": "integer", "description": "Number of protocol configs to be migrated (always 0 or 1 \u2014 the project-level REST\/GraphQL\/WebSocket flags).", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "project-labels": { "type": "integer", "description": "Number of label sets to be migrated (always 0 or 1 \u2014 the project-level RBAC label array).", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "project-services": { "type": "integer", "description": "Number of service configs to be migrated (always 0 or 1 \u2014 the project-level enable\/disable flags for all 17 services).", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "policies": { "type": "integer", "description": "Number of policy bundles to be migrated (always 0 or 1 \u2014 the project-level security policies covering password rules, session behavior, user limits, and membership privacy).", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "smtp": { "type": "integer", "description": "Number of SMTP configurations to be migrated (always 0 or 1 \u2014 the project-level custom SMTP settings; password is not exposed by the source API).", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "rule": { "type": "integer", "description": "Number of custom-domain proxy rules to be migrated. Auto-generated `.appwrite.network` rules are skipped \u2014 they are recreated by parent Function\/Site migration.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "project-email-template": { "type": "integer", "description": "Number of custom email templates to be migrated (one per templateId \u00d7 locale pair).", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "site": { "type": "integer", "description": "Number of sites to be migrated.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "provider": { "type": "integer", "description": "Number of providers to be migrated.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "topic": { "type": "integer", "description": "Number of topics to be migrated.", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 }, "subscriber": { "type": "integer", "description": "Number of subscribers to be migrated.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "message": { "type": "integer", "description": "Number of messages to be migrated.", - "x-example": 50, - "format": "int32" + "format": "int32", + "example": 50 }, "size": { "type": "integer", "description": "Size of files to be migrated in mb.", - "x-example": 30000, - "format": "int32" + "format": "int32", + "example": 30000 }, "version": { "type": "string", "description": "Version of the Appwrite instance to be migrated.", - "x-example": "1.4.0" + "example": "1.4.0" }, "oauth2-provider": { "type": "integer", "description": "Number of OAuth2 provider configurations to be migrated. Secrets (clientSecret, p8File) are never migrated \u2014 destination admin must re-enter them per provider.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "backup-policy": { "type": "integer", "description": "Number of backup policies to be migrated.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 } }, "required": [ @@ -112104,67 +112000,67 @@ "$id": { "type": "string", "description": "Insight ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Insight creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Insight update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "reportId": { "type": "string", "description": "Parent report ID. Insights always belong to a report.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "type": { "type": "string", "description": "Insight type. One of databaseIndex (legacy), tablesDBIndex, documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance, siteAccessibility, siteSeo, functionPerformance. The index types are engine-specific so each CTA can pair the right service+method (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or vectorsDB.createIndex).", - "x-example": "tablesDBIndex" + "example": "tablesDBIndex" }, "severity": { "type": "string", "description": "Insight severity. One of info, warning, critical.", - "x-example": "warning" + "example": "warning" }, "status": { "type": "string", "description": "Insight status. One of active, dismissed.", - "x-example": "active" + "example": "active" }, "resourceType": { "type": "string", "description": "Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.", - "x-example": "databases" + "example": "databases" }, "resourceId": { "type": "string", "description": "ID of the resource the insight is about.", - "x-example": "main" + "example": "main" }, "parentResourceType": { "type": "string", "description": "Plural noun for the parent resource that contains the insight's resource, e.g. an insight about a column index on a table \u2192 resourceType=indexes, parentResourceType=tables. Empty when the resource has no parent.", - "x-example": "tables" + "example": "tables" }, "parentResourceId": { "type": "string", "description": "ID of the parent resource. Empty when the resource has no parent.", - "x-example": "orders" + "example": "orders" }, "title": { "type": "string", "description": "Insight title.", - "x-example": "Missing index on collection orders" + "example": "Missing index on collection orders" }, "summary": { "type": "string", "description": "Short markdown summary describing the insight.", - "x-example": "Queries against `orders.status` are scanning the full collection." + "example": "Queries against `orders.status` are scanning the full collection." }, "ctas": { "type": "array", @@ -112172,24 +112068,24 @@ "items": { "$ref": "#\/components\/schemas\/insightCTA" }, - "x-example": [] + "example": [] }, "analyzedAt": { "type": "string", "description": "Time the insight was analyzed in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "dismissedAt": { "type": "string", "description": "Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "dismissedBy": { "type": "string", "description": "User ID that dismissed the insight. Empty when not dismissed.", - "x-example": "5e5ea5c16897e", + "example": "5e5ea5c16897e", "nullable": true } }, @@ -112236,23 +112132,23 @@ "label": { "type": "string", "description": "Human-readable label for the CTA, used in UI.", - "x-example": "Create missing index" + "example": "Create missing index" }, "service": { "type": "string", "description": "Public API service (SDK namespace) the client should invoke. Must match the engine that owns the resource \u2014 for index suggestions: databases (legacy), tablesDB, documentsDB, or vectorsDB.", - "x-example": "tablesDB" + "example": "tablesDB" }, "method": { "type": "string", "description": "Public API method on the chosen service the client should invoke when this CTA is triggered.", - "x-example": "createIndex" + "example": "createIndex" }, "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": { + "example": { "databaseId": "main", "tableId": "orders", "key": "_idx_status", @@ -112291,47 +112187,47 @@ "$id": { "type": "string", "description": "Report ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Report creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Report update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "ID of the third-party app that submitted the report.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "type": { "type": "string", "description": "Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.", - "x-example": "lighthouse" + "example": "lighthouse" }, "title": { "type": "string", "description": "Short, human-readable title for the report.", - "x-example": "Lighthouse audit for https:\/\/appwrite.io\/" + "example": "Lighthouse audit for https:\/\/appwrite.io\/" }, "summary": { "type": "string", "description": "Markdown summary describing the report.", - "x-example": "Performance score 78. 4 opportunities found." + "example": "Performance score 78. 4 opportunities found." }, "targetType": { "type": "string", "description": "Plural noun describing what the report analyzes, e.g. databases, sites, urls.", - "x-example": "urls" + "example": "urls" }, "target": { "type": "string", "description": "Free-form target identifier (URL for lighthouse, resource ID for db).", - "x-example": "https:\/\/appwrite.io\/" + "example": "https:\/\/appwrite.io\/" }, "categories": { "type": "array", @@ -112339,7 +112235,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "performance", "accessibility" ] @@ -112350,12 +112246,12 @@ "items": { "$ref": "#\/components\/schemas\/insight" }, - "x-example": [] + "example": [] }, "analyzedAt": { "type": "string", "description": "Time the report was analyzed in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -112397,147 +112293,147 @@ "$id": { "type": "string", "description": "Event ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "actorType": { "type": "string", "description": "Actor type.", - "x-example": "user" + "example": "user" }, "actorId": { "type": "string", "description": "Actor ID.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "actorEmail": { "type": "string", "description": "Actor Email.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "actorName": { "type": "string", "description": "Actor Name.", - "x-example": "John Doe" + "example": "John Doe" }, "resourceParent": { "type": "string", "description": "Resource parent.", - "x-example": "database\/ID" + "example": "database\/ID" }, "resourceType": { "type": "string", "description": "Resource type.", - "x-example": "collection" + "example": "collection" }, "resourceId": { "type": "string", "description": "Resource ID.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "resource": { "type": "string", "description": "Resource.", - "x-example": "collections\/610fc2f985ee0" + "example": "collections\/610fc2f985ee0" }, "event": { "type": "string", "description": "Event name.", - "x-example": "account.sessions.create" + "example": "account.sessions.create" }, "userAgent": { "type": "string", "description": "User agent.", - "x-example": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/86.0.4240.198 Safari\/537.36" + "example": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/86.0.4240.198 Safari\/537.36" }, "ip": { "type": "string", "description": "IP address.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "mode": { "type": "string", "description": "API mode when event triggered.", - "x-example": "admin" + "example": "admin" }, "country": { "type": "string", "description": "Location.", - "x-example": "US" + "example": "US" }, "continentCode": { "type": "string", "description": "Continent code.", - "x-example": "NA" + "example": "NA" }, "city": { "type": "string", "description": "City name.", - "x-example": "Mountain View" + "example": "Mountain View" }, "subdivisions": { "type": "string", "description": "Region\/state chain.", - "x-example": "California" + "example": "California" }, "isp": { "type": "string", "description": "Internet service provider.", - "x-example": "Google" + "example": "Google" }, "autonomousSystemNumber": { "type": "string", "description": "Autonomous System Number (ASN).", - "x-example": "15169" + "example": "15169" }, "autonomousSystemOrganization": { "type": "string", "description": "Organization that owns the ASN.", - "x-example": "GOOGLE" + "example": "GOOGLE" }, "connectionType": { "type": "string", "description": "Connection type (e.g. cable, cellular, corporate).", - "x-example": "cable" + "example": "cable" }, "connectionUsageType": { "type": "string", "description": "User type (e.g. residential, business, hosting).", - "x-example": "residential" + "example": "residential" }, "connectionOrganization": { "type": "string", "description": "Registered organization of the IP.", - "x-example": "Google LLC" + "example": "Google LLC" }, "time": { "type": "string", "description": "Log creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "hostname": { "type": "string", "description": "Hostname.", - "x-example": "appwrite.io" + "example": "appwrite.io" }, "sdk": { "type": "string", "description": "Name of the SDK that triggered the event.", - "x-example": "web" + "example": "web" }, "sdkVersion": { "type": "string", "description": "Version of the SDK that triggered the event.", - "x-example": "14.0.0" + "example": "14.0.0" } }, "required": [ @@ -112610,34 +112506,34 @@ "name": { "type": "string", "description": "Resource name", - "x-example": "" + "example": "" }, "unit": { "type": "string", "description": "Resource unit", - "x-example": "GB" + "example": "GB" }, "currency": { "type": "string", "description": "Price currency", - "x-example": "USD" + "example": "USD" }, "price": { "type": "number", "description": "Price", - "x-example": 5, - "format": "double" + "format": "double", + "example": 5 }, "value": { "type": "integer", "description": "Resource value", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "invoiceDesc": { "type": "string", "description": "Description on invoice", - "x-example": "" + "example": "" } }, "required": [ @@ -112664,17 +112560,17 @@ "$id": { "type": "string", "description": "Addon ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Addon creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Addon update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -112682,40 +112578,39 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "key": { "type": "string", "description": "Addon key", - "x-example": "baa" + "example": "baa" }, "resourceType": { "type": "string", "description": "Resource type (organization or project)", - "x-example": "organization" + "example": "organization" }, "resourceId": { "type": "string", "description": "Resource ID", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "status": { "type": "string", "description": "Payment status. Possible values: pending (awaiting payment confirmation e.g. 3DS), active (payment confirmed and addon is running).", - "x-example": "active" + "example": "active" }, "currentValue": { "type": "integer", "description": "Current value for this billing cycle. For toggle addons: 1 (on) or 0 (off). For numeric addons: the active quantity.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "nextValue": { "type": "integer", "description": "Value to apply at the start of the next billing cycle. Null means no change is scheduled. For toggle addons, 0 means the addon will be removed at the next cycle.", - "x-example": null, "format": "int32", "nullable": true } @@ -112753,46 +112648,46 @@ "addonKey": { "type": "string", "description": "Addon key.", - "x-example": "baa" + "example": "baa" }, "name": { "type": "string", "description": "Addon display name.", - "x-example": "HIPAA BAA" + "example": "HIPAA BAA" }, "monthlyPrice": { "type": "number", "description": "Full monthly price of the addon.", - "x-example": 350, - "format": "double" + "format": "double", + "example": 350 }, "proratedAmount": { "type": "number", "description": "Calculated prorated amount for the current billing cycle.", - "x-example": 175.5, - "format": "double" + "format": "double", + "example": 175.5 }, "remainingDays": { "type": "integer", "description": "Days remaining in the current billing cycle.", - "x-example": 15, - "format": "int32" + "format": "int32", + "example": 15 }, "totalCycleDays": { "type": "integer", "description": "Total days in the billing cycle.", - "x-example": 30, - "format": "int32" + "format": "int32", + "example": 30 }, "currency": { "type": "string", "description": "Currency code.", - "x-example": "USD" + "example": "USD" }, "billingCycleEnd": { "type": "string", "description": "When the current billing cycle ends.", - "x-example": "2024-02-01T00:00:00.000+00:00" + "example": "2024-02-01T00:00:00.000+00:00" } }, "required": [ @@ -112823,32 +112718,32 @@ "$id": { "type": "string", "description": "Link ID. This is the shareable referral code.", - "x-example": "my-campaign" + "example": "my-campaign" }, "$createdAt": { "type": "string", "description": "Link creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Link update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID of the link owner.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Optional link name.", - "x-example": "Launch campaign" + "example": "Launch campaign" }, "status": { "type": "string", "description": "Link status. Can be one of `active` or `disabled`.", - "x-example": "active" + "example": "active" } }, "required": [ @@ -112875,16 +112770,15 @@ "total": { "type": "integer", "description": "Total number of links that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "links": { "type": "array", "description": "List of links.", "items": { "$ref": "#\/components\/schemas\/affiliateLink" - }, - "x-example": "" + } } }, "required": [ @@ -112903,52 +112797,52 @@ "$id": { "type": "string", "description": "Referral ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Referral creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Referral update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "linkId": { "type": "string", "description": "Affiliate link ID used for attribution.", - "x-example": "my-campaign" + "example": "my-campaign" }, "referredUserMaskedId": { "type": "string", "description": "Privacy-safe truncated referred user ID.", - "x-example": "****97e" + "example": "****97e" }, "referredUserCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the referred user at signup, when available.", - "x-example": "us" + "example": "us" }, "status": { "type": "string", "description": "Referral status. Can be one of `pending`, `converted`, or `expired`. `expired` is derived from `expiresAt` when still pending.", - "x-example": "pending" + "example": "pending" }, "attributedAt": { "type": "string", "description": "Attribution time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "expiresAt": { "type": "string", "description": "Attribution expiry time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "convertedAt": { "type": "string", "description": "Conversion time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -112983,16 +112877,15 @@ "total": { "type": "integer", "description": "Total number of referrals that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "referrals": { "type": "array", "description": "List of referrals.", "items": { "$ref": "#\/components\/schemas\/affiliateReferral" - }, - "x-example": "" + } } }, "required": [ @@ -113011,54 +112904,54 @@ "$id": { "type": "string", "description": "Reward ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Reward creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Reward update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID of the reward owner.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "linkId": { "type": "string", "description": "Affiliate link ID that earned this reward.", - "x-example": "my-campaign" + "example": "my-campaign" }, "referralId": { "type": "string", "description": "Referral ID that earned this reward.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "amount": { "type": "number", "description": "Reward amount in USD.", - "x-example": 10, - "format": "double" + "format": "double", + "example": 10 }, "status": { "type": "string", "description": "Reward status. Can be one of `pending` or `claimed`.", - "x-example": "pending" + "example": "pending" }, "teamId": { "type": "string", "description": "Organization ID the reward was claimed on.", - "x-example": "5e5ea5c16897e", + "example": "5e5ea5c16897e", "nullable": true }, "creditId": { "type": "string", "description": "Credit document ID created when the reward was claimed.", - "x-example": "5e5ea5c16897e", + "example": "5e5ea5c16897e", "nullable": true } }, @@ -113092,16 +112985,15 @@ "total": { "type": "integer", "description": "Total number of rewards that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "rewards": { "type": "array", "description": "List of rewards.", "items": { "$ref": "#\/components\/schemas\/affiliateReward" - }, - "x-example": "" + } } }, "required": [ @@ -113120,31 +113012,30 @@ "$id": { "type": "string", "description": "Aggregation ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Project name", - "x-example": "" + "example": "" }, "region": { "type": "string", "description": "Project region", - "x-example": "fra" + "example": "fra" }, "amount": { "type": "integer", "description": "Aggregated amount", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "resources": { "type": "array", "description": "", "items": { "$ref": "#\/components\/schemas\/usageResources" - }, - "x-example": "" + } } }, "required": [ @@ -113169,17 +113060,17 @@ "$id": { "type": "string", "description": "Aggregation ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Aggregation creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Aggregation update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -113187,144 +113078,144 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "from": { "type": "string", "description": "Beginning date of the invoice", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "to": { "type": "string", "description": "End date of the invoice", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "usageStorage": { "type": "integer", "description": "Total storage usage", - "x-example": 20009090, - "format": "int32" + "format": "int32", + "example": 20009090 }, "usageTotalStorage": { "type": "integer", "description": "Total storage usage with builds storage", - "x-example": 20009090, - "format": "int32" + "format": "int32", + "example": 20009090 }, "usageFilesStorage": { "type": "integer", "description": "Total files storage usage", - "x-example": 20009090, - "format": "int32" + "format": "int32", + "example": 20009090 }, "usageDeploymentsStorage": { "type": "integer", "description": "Total deployments storage usage", - "x-example": 20009090, - "format": "int32" + "format": "int32", + "example": 20009090 }, "usageBuildsStorage": { "type": "integer", "description": "Total builds storage usage", - "x-example": 20009090, - "format": "int32" + "format": "int32", + "example": 20009090 }, "usageDatabasesStorage": { "type": "integer", "description": "Total databases storage usage", - "x-example": 2009090, - "format": "int32" + "format": "int32", + "example": 2009090 }, "usageUsers": { "type": "integer", "description": "Total active users for the billing period", - "x-example": 2000, - "format": "int32" + "format": "int32", + "example": 2000 }, "usageExecutions": { "type": "integer", "description": "Total number of executions for the billing period", - "x-example": 2000, - "format": "int32" + "format": "int32", + "example": 2000 }, "usageBandwidth": { "type": "integer", "description": "Total bandwidth usage for the billing period", - "x-example": 2000, - "format": "int32" + "format": "int32", + "example": 2000 }, "usageRealtime": { "type": "integer", "description": "Peak concurrent realtime connections for the billing period", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 }, "usageRealtimeMessages": { "type": "integer", "description": "Total realtime messages sent for the billing period", - "x-example": 10000, - "format": "int32" + "format": "int32", + "example": 10000 }, "usageRealtimeBandwidth": { "type": "integer", "description": "Total realtime bandwidth usage for the billing period", - "x-example": 5000000, - "format": "int32" + "format": "int32", + "example": 5000000 }, "additionalMembers": { "type": "integer", "description": "Additional members", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "additionalMemberAmount": { "type": "integer", "description": "Additional members cost", - "x-example": 30, - "format": "int32" + "format": "int32", + "example": 30 }, "additionalStorageAmount": { "type": "integer", "description": "Additional storage usage cost", - "x-example": 40, - "format": "int32" + "format": "int32", + "example": 40 }, "additionalUsersAmount": { "type": "integer", "description": "Additional users usage cost.", - "x-example": 4, - "format": "int32" + "format": "int32", + "example": 4 }, "additionalExecutionsAmount": { "type": "integer", "description": "Additional executions usage cost", - "x-example": 30, - "format": "int32" + "format": "int32", + "example": 30 }, "additionalBandwidthAmount": { "type": "integer", "description": "Additional bandwidth usage cost", - "x-example": 40, - "format": "int32" + "format": "int32", + "example": 40 }, "additionalRealtimeAmount": { "type": "integer", "description": "Additional realtime usage cost", - "x-example": 20, - "format": "int32" + "format": "int32", + "example": 20 }, "plan": { "type": "string", "description": "Billing plan", - "x-example": "tier-0" + "example": "tier-0" }, "amount": { "type": "integer", "description": "Aggregated amount", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "breakdown": { "type": "array", @@ -113332,7 +113223,7 @@ "items": { "$ref": "#\/components\/schemas\/aggregationBreakdown" }, - "x-example": [] + "example": [] }, "resources": { "type": "array", @@ -113340,7 +113231,7 @@ "items": { "$ref": "#\/components\/schemas\/usageResources" }, - "x-example": [] + "example": [] } }, "required": [ @@ -113415,43 +113306,43 @@ "$id": { "type": "string", "description": "Archive ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Archive creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Archive update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "policyId": { "type": "string", "description": "Archive policy ID.", - "x-example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7" }, "size": { "type": "integer", "description": "Archive size in bytes.", - "x-example": 100000, - "format": "int32" + "format": "int32", + "example": 100000 }, "status": { "type": "string", "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.", - "x-example": "completed" + "example": "completed" }, "startedAt": { "type": "string", "description": "The backup start time.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "migrationId": { "type": "string", "description": "Migration ID.", - "x-example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7" }, "services": { "type": "array", @@ -113459,7 +113350,9 @@ "items": { "type": "string" }, - "x-example": "['databases', 'storage']" + "example": [ + "['databases', 'storage']" + ] }, "resources": { "type": "array", @@ -113467,18 +113360,20 @@ "items": { "type": "string" }, - "x-example": "['databases', 'collections', 'attributes', 'indexes']" + "example": [ + "['databases', 'collections', 'attributes', 'indexes']" + ] }, "resourceId": { "type": "string", "description": "The resource ID to backup. Set only if this archive should backup a single resource.", - "x-example": "DB1", + "example": "DB1", "nullable": true }, "resourceType": { "type": "string", "description": "The resource type to backup. Set only if this archive should backup a single resource.", - "x-example": "database", + "example": "database", "nullable": true } }, @@ -113516,93 +113411,93 @@ "$id": { "type": "string", "description": "Backup ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Backup creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "databaseId": { "type": "string", "description": "Database ID this backup belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "policyId": { "type": "string", "description": "Backup policy ID when the backup was created by a schedule.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "trigger": { "type": "string", "description": "Backup trigger. Possible values: manual, schedule.", - "x-example": "schedule" + "example": "schedule" }, "type": { "type": "string", "description": "Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup), wal (write-ahead log continuous archival).", - "x-example": "full" + "example": "full" }, "requestedType": { "type": "string", "description": "Backup type that was requested. Differs from `type` when the backend could not run the requested type and took a different one instead, in which case `fallbackReason` explains why. Empty for backups taken before the requested type was recorded.", - "x-example": "incremental" + "example": "incremental" }, "fallbackReason": { "type": "string", "description": "Why the backend ran a different backup type than the one requested. Empty when the backup ran as requested.", - "x-example": "PostgreSQL incremental backups are not offered because they cannot be restored: archived WAL is physical and cannot replay onto a logically-restored base. A full backup was taken instead; use a point-in-time restore (targetTime) to recover to a moment between fulls." + "example": "PostgreSQL incremental backups are not offered because they cannot be restored: archived WAL is physical and cannot replay onto a logically-restored base. A full backup was taken instead; use a point-in-time restore (targetTime) to recover to a moment between fulls." }, "status": { "type": "string", "description": "Backup status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error), verified (integrity check passed).", - "x-example": "completed" + "example": "completed" }, "sizeBytes": { "type": "integer", "description": "Backup size in bytes.", - "x-example": 1073741824, - "format": "int32" + "format": "int32", + "example": 1073741824 }, "startedAt": { "type": "string", "description": "Backup start time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "completedAt": { "type": "string", "description": "Backup completion time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "verifiedAt": { "type": "string", "description": "Backup verification time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "expiresAt": { "type": "string", "description": "Backup expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "logPosition": { "type": "string", "description": "Transaction-log position the backup anchors at, in the engine's own notation: PostgreSQL `{walSegment}|{lsn}`, MySQL and MariaDB `{binlogFile}|{offset}`, MongoDB `{seconds}|{increment}`. Empty when the backup recorded no position, which is the case for backup types that carry none.", - "x-example": "000000010000000000000003|0\/3000148", + "example": "000000010000000000000003|0\/3000148", "nullable": true }, "error": { "type": "string", "description": "Error message if backup failed.", - "x-example": "" + "example": "" } }, "required": [ @@ -113646,8 +113541,8 @@ "total": { "type": "integer", "description": "Total number of backups.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "backups": { "type": "array", @@ -113655,7 +113550,7 @@ "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseBackup" }, - "x-example": [] + "example": [] } }, "required": [ @@ -113674,27 +113569,27 @@ "provider": { "type": "string", "description": "Storage provider. Possible values: s3 (Amazon S3 or S3-compatible), gcs (Google Cloud Storage), azure (Azure Blob Storage).", - "x-example": "s3" + "example": "s3" }, "bucket": { "type": "string", "description": "Storage bucket or container name.", - "x-example": "my-backup-bucket" + "example": "my-backup-bucket" }, "region": { "type": "string", "description": "Storage region.", - "x-example": "us-east-1" + "example": "us-east-1" }, "prefix": { "type": "string", "description": "Object key prefix for backups.", - "x-example": "backups\/" + "example": "backups\/" }, "endpoint": { "type": "string", "description": "Custom endpoint for S3-compatible storage.", - "x-example": "https:\/\/minio.example.com" + "example": "https:\/\/minio.example.com" } }, "required": [ @@ -113719,42 +113614,42 @@ "$id": { "type": "string", "description": "Region ID", - "x-example": "eu-fr" + "example": "eu-fr" }, "userId": { "type": "string", "description": "User ID", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "streetAddress": { "type": "string", "description": "Street address", - "x-example": "13th Avenue" + "example": "13th Avenue" }, "addressLine2": { "type": "string", "description": "Address line 2", - "x-example": "" + "example": "" }, "country": { "type": "string", "description": "Address country", - "x-example": "USA" + "example": "USA" }, "city": { "type": "string", "description": "city", - "x-example": "" + "example": "" }, "state": { "type": "string", "description": "state", - "x-example": "" + "example": "" }, "postalCode": { "type": "string", "description": "postal code", - "x-example": "" + "example": "" } }, "required": [ @@ -113785,57 +113680,57 @@ "bandwidth": { "type": "integer", "description": "Bandwidth limit", - "x-example": 5, "format": "int32", + "example": 5, "nullable": true }, "storage": { "type": "integer", "description": "Storage limit", - "x-example": 150, "format": "int32", + "example": 150, "nullable": true }, "users": { "type": "integer", "description": "Users limit", - "x-example": 200000, "format": "int32", + "example": 200000, "nullable": true }, "executions": { "type": "integer", "description": "Executions limit", - "x-example": 750000, "format": "int32", + "example": 750000, "nullable": true }, "GBHours": { "type": "integer", "description": "GBHours limit", - "x-example": 100, "format": "int32", + "example": 100, "nullable": true }, "imageTransformations": { "type": "integer", "description": "Image transformations limit", - "x-example": 100, "format": "int32", + "example": 100, "nullable": true }, "authPhone": { "type": "integer", "description": "Auth phone limit", - "x-example": 10, "format": "int32", + "example": 10, "nullable": true }, "budgetLimit": { "type": "integer", "description": "Budget limit percentage", - "x-example": 100, "format": "int32", + "example": 100, "nullable": true } }, @@ -113857,217 +113752,217 @@ "$id": { "type": "string", "description": "Plan ID.", - "x-example": "tier-0" + "example": "tier-0" }, "name": { "type": "string", "description": "Plan name", - "x-example": "Hobby" + "example": "Hobby" }, "desc": { "type": "string", "description": "Plan description", - "x-example": "Hobby plan" + "example": "Hobby plan" }, "order": { "type": "integer", "description": "Plan order", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "price": { "type": "number", "description": "Price", - "x-example": 25, - "format": "double" + "format": "double", + "example": 25 }, "trial": { "type": "integer", "description": "Trial days", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "bandwidth": { "type": "integer", "description": "Bandwidth", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "storage": { "type": "integer", "description": "Storage", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "imageTransformations": { "type": "integer", "description": "Image Transformations", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "screenshotsGenerated": { "type": "integer", "description": "Screenshots generated", - "x-example": 50, - "format": "int32" + "format": "int32", + "example": 50 }, "members": { "type": "integer", "description": "Members", - "x-example": 25, "format": "int32", + "example": 25, "nullable": true }, "webhooks": { "type": "integer", "description": "Webhooks", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "wafRules": { "type": "integer", "description": "Maximum WAF rules per project", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "projects": { "type": "integer", "description": "Projects", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "platforms": { "type": "integer", "description": "Platforms", - "x-example": 3, - "format": "int32" + "format": "int32", + "example": 3 }, "users": { "type": "integer", "description": "Users", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "teams": { "type": "integer", "description": "Teams", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "databases": { "type": "integer", "description": "Databases", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "databasesReads": { "type": "integer", "description": "Database reads per month", - "x-example": 500000, - "format": "int32" + "format": "int32", + "example": 500000 }, "databasesWrites": { "type": "integer", "description": "Database writes per month", - "x-example": 250000, - "format": "int32" + "format": "int32", + "example": 250000 }, "databasesBatchSize": { "type": "integer", "description": "Database batch size limit", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "buckets": { "type": "integer", "description": "Buckets", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "fileSize": { "type": "integer", "description": "File size", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "functions": { "type": "integer", "description": "Functions", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "sites": { "type": "integer", "description": "Sites", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "executions": { "type": "integer", "description": "Function executions", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "executionsRetentionCount": { "type": "integer", "description": "Rolling max executions retained per function\/site", - "x-example": 10000, - "format": "int32" + "format": "int32", + "example": 10000 }, "GBHours": { "type": "integer", "description": "GB hours for functions", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "realtime": { "type": "integer", "description": "Realtime connections", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "realtimeMessages": { "type": "integer", "description": "Realtime messages", - "x-example": 100000, - "format": "int32" + "format": "int32", + "example": 100000 }, "messages": { "type": "integer", "description": "Messages per month", - "x-example": 1000, - "format": "int32" + "format": "int32", + "example": 1000 }, "topics": { "type": "integer", "description": "Topics for messaging", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "authPhone": { "type": "integer", "description": "SMS authentications per month", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 }, "domains": { "type": "integer", "description": "Custom domains", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "activityLogs": { "type": "integer", "description": "Activity log days", - "x-example": 7, "format": "int32", + "example": 7, "nullable": true }, "usageLogs": { "type": "integer", "description": "Usage history days", - "x-example": 30, - "format": "int32" + "format": "int32", + "example": 30 }, "usageLogsIntervals": { "type": "array", @@ -114075,7 +113970,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "15m", "1h", "1d" @@ -114085,19 +113980,18 @@ "projectInactivityDays": { "type": "integer", "description": "Number of days of console inactivity before a project is paused. 0 means pausing is disabled.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "alertLimit": { "type": "integer", "description": "Alert threshold percentage", - "x-example": 80, - "format": "int32" + "format": "int32", + "example": 80 }, "usage": { "type": "object", "description": "Additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/usageBillingPlan" @@ -114107,7 +114001,6 @@ "addons": { "type": "object", "description": "Addons", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanAddon" @@ -114117,108 +114010,107 @@ "budgetCapEnabled": { "type": "boolean", "description": "Budget cap enabled or disabled.", - "x-example": true + "example": true }, "customSmtp": { "type": "boolean", "description": "Custom SMTP", - "x-example": true + "example": true }, "emailBranding": { "type": "boolean", "description": "Appwrite branding in email", - "x-example": true + "example": true }, "requiresPaymentMethod": { "type": "boolean", "description": "Does plan require payment method", - "x-example": true + "example": true }, "requiresBillingAddress": { "type": "boolean", "description": "Does plan require billing address", - "x-example": true + "example": true }, "isAvailable": { "type": "boolean", "description": "Is the billing plan available", - "x-example": true + "example": true }, "selfService": { "type": "boolean", "description": "Can user change the plan themselves", - "x-example": true + "example": true }, "premiumSupport": { "type": "boolean", "description": "Does plan enable premium support", - "x-example": true + "example": true }, "budgeting": { "type": "boolean", "description": "Does plan support budget cap", - "x-example": true + "example": true }, "supportsMockNumbers": { "type": "boolean", "description": "Does plan support mock numbers", - "x-example": true + "example": true }, "supportsOrganizationRoles": { "type": "boolean", "description": "Does plan support organization roles", - "x-example": true + "example": true }, "supportsCredits": { "type": "boolean", "description": "Does plan support credit", - "x-example": true + "example": true }, "supportsDedicatedDatabases": { "type": "boolean", "description": "Does plan support dedicated databases.", - "x-example": true + "example": true }, "supportsDisposableEmailValidation": { "type": "boolean", "description": "Does plan support blocking disposable email addresses.", - "x-example": true + "example": true }, "supportsCanonicalEmailValidation": { "type": "boolean", "description": "Does plan support requiring canonical email addresses.", - "x-example": true + "example": true }, "supportsFreeEmailValidation": { "type": "boolean", "description": "Does plan support blocking free email addresses.", - "x-example": true + "example": true }, "supportsCorporateEmailValidation": { "type": "boolean", "description": "Does plan support restricting sign-ups to corporate email addresses only.", - "x-example": true + "example": true }, "supportsProjectSpecificRoles": { "type": "boolean", "description": "Does plan support project-specific member roles.", - "x-example": true + "example": true }, "backupsEnabled": { "type": "boolean", "description": "Does plan support backup policies.", - "x-example": true, + "example": true, "nullable": true }, "usagePerProject": { "type": "boolean", "description": "Whether usage addons are calculated per project.", - "x-example": true + "example": true }, "supportedAddons": { "type": "object", "description": "Supported addons for this plan", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanSupportedAddons" @@ -114228,31 +114120,30 @@ "backupPolicies": { "type": "integer", "description": "How many policies does plan support", - "x-example": 1, "format": "int32", + "example": 1, "nullable": true }, "deploymentSize": { "type": "integer", "description": "Maximum function and site deployment size in MB", - "x-example": 30, - "format": "int32" + "format": "int32", + "example": 30 }, "buildSize": { "type": "integer", "description": "Maximum function and site deployment size in MB", - "x-example": 2000, - "format": "int32" + "format": "int32", + "example": 2000 }, "databasesAllowEncrypt": { "type": "boolean", "description": "Does the plan support encrypted string attributes or not.", - "x-example": false + "example": false }, "limits": { "type": "object", "description": "Plan specific limits", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanLimits" @@ -114263,7 +114154,7 @@ "group": { "type": "string", "description": "Group of this billing plan for variants", - "x-example": "pro", + "example": "pro", "enum": [ "starter", "pro", @@ -114273,7 +114164,6 @@ "program": { "type": "object", "description": "Details of the program this plan is a part of.", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/program" @@ -114284,13 +114174,12 @@ "databaseComputeCredit": { "type": "number", "description": "Included monthly dedicated-database compute credit in USD. Resets each billing cycle with no roll-over.", - "x-example": 10, - "format": "double" + "format": "double", + "example": 10 }, "dedicatedDatabases": { "type": "object", "description": "Dedicated database limits available to this plan.", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanDedicatedDatabaseLimits" @@ -114449,7 +114338,6 @@ "seats": { "type": "object", "description": "Addon seats", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanAddonDetails" @@ -114460,7 +114348,6 @@ "projects": { "type": "object", "description": "Addon projects", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanAddonDetails" @@ -114481,47 +114368,47 @@ "supported": { "type": "boolean", "description": "Is the addon supported in the plan?", - "x-example": true + "example": true }, "planIncluded": { "type": "integer", "description": "Addon plan included value", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "limit": { "type": "integer", "description": "Addon limit", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "type": { "type": "string", "description": "Addon type", - "x-example": "numeric" + "example": "numeric" }, "currency": { "type": "string", "description": "Price currency", - "x-example": "USD", + "example": "USD", "nullable": true }, "price": { "type": "number", "description": "Price", - "x-example": 5, - "format": "double" + "format": "double", + "example": 5 }, "value": { "type": "integer", "description": "Resource value", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "invoiceDesc": { "type": "string", "description": "Description on invoice", - "x-example": "" + "example": "" } }, "required": [ @@ -114551,15 +114438,15 @@ "credits": { "type": "integer", "description": "Credits limit per billing cycle", - "x-example": 100, "format": "int32", + "example": 100, "nullable": true }, "dailyCredits": { "type": "integer", "description": "Daily credits limit (if applicable)", - "x-example": 5, "format": "int32", + "example": 5, "nullable": true } }, @@ -114575,113 +114462,113 @@ "minCpu": { "type": "integer", "description": "Minimum CPU allocation in millicores.", - "x-example": 125, "format": "int32", + "example": 125, "nullable": true }, "maxCpu": { "type": "integer", "description": "Maximum CPU allocation in millicores.", - "x-example": 16000, "format": "int32", + "example": 16000, "nullable": true }, "minMemoryMb": { "type": "integer", "description": "Minimum memory allocation in megabytes.", - "x-example": 128, "format": "int32", + "example": 128, "nullable": true }, "maxMemoryMb": { "type": "integer", "description": "Maximum memory allocation in megabytes.", - "x-example": 65536, "format": "int32", + "example": 65536, "nullable": true }, "minStorageGb": { "type": "integer", "description": "Minimum storage allocation in gigabytes.", - "x-example": 1, "format": "int32", + "example": 1, "nullable": true }, "maxStorageGb": { "type": "integer", "description": "Maximum storage allocation in gigabytes.", - "x-example": 16384, "format": "int32", + "example": 16384, "nullable": true }, "maxReplicas": { "type": "integer", "description": "Maximum number of high-availability replicas per dedicated database.", - "x-example": 5, "format": "int32", + "example": 5, "nullable": true }, "maxConnections": { "type": "integer", "description": "Maximum number of client connections.", - "x-example": 10000, "format": "int32", + "example": 10000, "nullable": true }, "maxIpAllowlistSize": { "type": "integer", "description": "Maximum number of entries allowed in the IP allowlist.", - "x-example": 100, "format": "int32", + "example": 100, "nullable": true }, "maxExtensions": { "type": "integer", "description": "Maximum number of database extensions that can be enabled.", - "x-example": 50, "format": "int32", + "example": 50, "nullable": true }, "maxBackupRetentionDays": { "type": "integer", "description": "Maximum number of days a backup can be retained.", - "x-example": 365, "format": "int32", + "example": 365, "nullable": true }, "maxPitrRetentionDays": { "type": "integer", "description": "Maximum number of days of point-in-time recovery data that can be retained.", - "x-example": 35, "format": "int32", + "example": 35, "nullable": true }, "maxSqlApiMaxRows": { "type": "integer", "description": "Maximum number of rows a single SQL API query can return.", - "x-example": 1000000, "format": "int32", + "example": 1000000, "nullable": true }, "maxSqlApiMaxBytes": { "type": "integer", "description": "Maximum response size in bytes for a single SQL API query.", - "x-example": 104857600, "format": "int32", + "example": 104857600, "nullable": true }, "maxSqlApiTimeoutSeconds": { "type": "integer", "description": "Maximum execution time in seconds for a single SQL API query.", - "x-example": 300, "format": "int32", + "example": 300, "nullable": true }, "maxSqlApiAllowedStatements": { "type": "integer", "description": "Maximum number of SQL statement types that can be permitted through the SQL API.", - "x-example": 10, "format": "int32", + "example": 10, "nullable": true }, "allowedSqlStatements": { @@ -114690,7 +114577,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "select", "insert", "update", @@ -114705,7 +114592,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "ssd" ], "nullable": true @@ -114716,7 +114603,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "async", "sync", "quorum" @@ -114765,17 +114652,17 @@ "baa": { "type": "boolean", "description": "Whether the plan supports BAA (Business Associate Agreement) addon", - "x-example": true + "example": true }, "premiumGeoDB": { "type": "boolean", "description": "Whether the plan supports Premium Geo DB addon (project-level)", - "x-example": true + "example": true }, "premiumGeoDBOrg": { "type": "boolean", "description": "Whether the plan supports Premium Geo DB addon (organization-level)", - "x-example": true + "example": true } }, "required": [ @@ -114796,59 +114683,59 @@ "$createdAt": { "type": "string", "description": "Block creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "resourceType": { "type": "string", "description": "Resource type that is blocked", - "x-example": "project" + "example": "project" }, "resourceId": { "type": "string", "description": "Resource identifier that is blocked", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "mode": { "type": "string", "description": "Block mode. full blocks reads and writes; readOnly blocks writes only.", - "x-example": "readOnly" + "example": "readOnly" }, "reason": { "type": "string", "description": "Reason for the block. Can be null if no reason was provided.", - "x-example": "Payment overdue", + "example": "Payment overdue", "nullable": true }, "expiredAt": { "type": "string", "description": "Block expiration date in ISO 8601 format. Can be null if the block does not expire.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "projectName": { "type": "string", "description": "Name of the project this block applies to.", - "x-example": "My Project" + "example": "My Project" }, "region": { "type": "string", "description": "Region of the project this block applies to.", - "x-example": "fra" + "example": "fra" }, "organizationName": { "type": "string", "description": "Name of the organization that owns the project.", - "x-example": "Acme Inc." + "example": "Acme Inc." }, "organizationId": { "type": "string", "description": "ID of the organization that owns the project.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "billingPlan": { "type": "string", "description": "Billing plan of the organization that owns the project.", - "x-example": "pro" + "example": "pro" } }, "required": [ @@ -114883,8 +114770,8 @@ "deleted": { "type": "integer", "description": "Number of blocks deleted", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "blocks": { "type": "array", @@ -114892,7 +114779,7 @@ "items": { "$ref": "#\/components\/schemas\/block" }, - "x-example": [] + "example": [] } }, "required": [ @@ -114911,64 +114798,64 @@ "branchId": { "type": "string", "description": "Branch identifier.", - "x-example": "a1b2c3d4" + "example": "a1b2c3d4" }, "branchName": { "type": "string", "description": "Branch name.", - "x-example": "branch-a1b2c3d4" + "example": "branch-a1b2c3d4" }, "namespace": { "type": "string", "description": "Kubernetes namespace where the branch is deployed.", - "x-example": "db-myproject-mydb-branch-a1b2c3d4" + "example": "db-myproject-mydb-branch-a1b2c3d4" }, "expiresAt": { "type": "integer", "description": "Unix timestamp when the branch expires.", - "x-example": 1711411200, - "format": "int32" + "format": "int32", + "example": 1711411200 }, "host": { "type": "string", "description": "Branch hostname for direct connections.", - "x-example": "db-myproject-mydb-a1b2c3d4.fra.appwrite.center" + "example": "db-myproject-mydb-a1b2c3d4.fra.appwrite.center" }, "port": { "type": "integer", "description": "Branch port. Null until the backing reports one.", - "x-example": 5432, - "format": "int32" + "format": "int32", + "example": 5432 }, "database": { "type": "string", "description": "Database name the client sends for routing to the branch.", - "x-example": "db-myproject-mydb-a1b2c3d4" + "example": "db-myproject-mydb-a1b2c3d4" }, "username": { "type": "string", "description": "Database username. Shared with the parent database.", - "x-example": "appwrite" + "example": "appwrite" }, "password": { "type": "string", "description": "Database password. Shared with the parent database.", - "x-example": "********" + "example": "********" }, "ssl": { "type": "boolean", "description": "Whether SSL is required.", - "x-example": false + "example": false }, "engine": { "type": "string", "description": "Database engine. Possible values: postgresql, mysql, mongodb.", - "x-example": "postgresql" + "example": "postgresql" }, "connectionString": { "type": "string", "description": "Full connection string for the branch.", - "x-example": "postgresql:\/\/appwrite:****@db-myproject-mydb-a1b2c3d4.fra.appwrite.center:5432\/db-myproject-mydb-a1b2c3d4?sslmode=disable" + "example": "postgresql:\/\/appwrite:****@db-myproject-mydb-a1b2c3d4.fra.appwrite.center:5432\/db-myproject-mydb-a1b2c3d4?sslmode=disable" } }, "required": [ @@ -115010,7 +114897,7 @@ "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseBranch" }, - "x-example": [] + "example": [] } }, "required": [ @@ -115027,52 +114914,51 @@ "$id": { "type": "string", "description": "Campaign ID", - "x-example": "" + "example": "" }, "template": { "type": "string", "description": "Campaign template", - "x-example": "" + "example": "" }, "title": { "type": "string", "description": "Campaign title", - "x-example": "" + "example": "" }, "description": { "type": "string", "description": "Campaign description", - "x-example": "" + "example": "" }, "plan": { "type": "string", "description": "Billing plan campaign is associated with", - "x-example": "", + "example": "", "nullable": true }, "cta": { "type": "string", "description": "Campaign CTA", - "x-example": "", + "example": "", "nullable": true }, "claimed": { "type": "string", "description": "Campaign info when claimed", - "x-example": "", + "example": "", "nullable": true }, "unclaimed": { "type": "string", "description": "Campaign infor when unclaimed", - "x-example": "", + "example": "", "nullable": true }, "image": { "type": "object", "additionalProperties": true, - "description": "Campaign images", - "x-example": "" + "description": "Campaign images" }, "reviews": { "type": "array", @@ -115080,19 +114966,16 @@ "items": { "$ref": "#\/components\/schemas\/review" }, - "x-example": "", "nullable": true }, "onlyNewOrgs": { "type": "boolean", "description": "Campaign valid only for new orgs.", - "x-example": "", "nullable": true }, "footer": { "type": "boolean", "description": "Is footer", - "x-example": "", "nullable": true } }, @@ -115124,44 +115007,44 @@ "$id": { "type": "string", "description": "coupon ID", - "x-example": "NEWBONUS" + "example": "NEWBONUS" }, "code": { "type": "string", "description": "coupon ID", - "x-example": "NEWBONUS" + "example": "NEWBONUS" }, "credits": { "type": "number", "description": "Provided credit amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "expiration": { "type": "string", "description": "Coupon expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "validity": { "type": "integer", "description": "Credit validity in days.", - "x-example": 180, - "format": "int32" + "format": "int32", + "example": 180 }, "campaign": { "type": "string", "description": "Campaign the coupon is associated with`.", - "x-example": "AppwriteHeroes" + "example": "AppwriteHeroes" }, "status": { "type": "string", "description": "Status of the coupon. Can be one of `disabled`, `active` or `expired`.", - "x-example": "disabled" + "example": "disabled" }, "onlyNewOrgs": { "type": "boolean", "description": "If the coupon is only valid for new organizations or not.", - "x-example": true + "example": true } }, "required": [ @@ -115192,17 +115075,17 @@ "$id": { "type": "string", "description": "Credit ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Credit creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Credit update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -115210,46 +115093,46 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "couponId": { "type": "string", "description": "coupon ID", - "x-example": "NEWBONUS" + "example": "NEWBONUS" }, "userId": { "type": "string", "description": "ID of the User.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "teamId": { "type": "string", "description": "ID of the Team.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "credits": { "type": "number", "description": "Provided credit amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "total": { "type": "number", "description": "Provided credit amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "expiration": { "type": "string", "description": "Credit expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "status": { "type": "string", "description": "Status of the credit. Can be one of `disabled`, `active` or `expired`.", - "x-example": "disabled" + "example": "disabled" } }, "required": [ @@ -115288,8 +115171,8 @@ "available": { "type": "integer", "description": "Total available credits for the organization.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 } }, "required": [ @@ -115309,19 +115192,21 @@ "items": { "$ref": "#\/components\/schemas\/credit" }, - "x-example": 5 + "example": [ + 5 + ] }, "total": { "type": "integer", "description": "Total number of credits", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "available": { "type": "number", "description": "Total available credit balance in USD", - "x-example": 5, - "format": "double" + "format": "double", + "example": 5 } }, "required": [ @@ -115342,84 +115227,84 @@ "$id": { "type": "string", "description": "Database migration ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Migration creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Migration update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "projectId": { "type": "string", "description": "Project ID that owns the migrating database.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "databaseId": { "type": "string", "description": "Logical database ID being migrated.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "specification": { "type": "string", "description": "Dedicated compute specification provisioned for the migration target.", - "x-example": "s-2vcpu-4gb" + "example": "s-2vcpu-4gb" }, "phase": { "type": "string", "description": "Migration phase. Possible values: pending, provisioned, capturing, backfilling, catching_up, verifying, ready_to_cutover, cutover, soaking, done, failed, rolled_back.", - "x-example": "pending" + "example": "pending" }, "attempt": { "type": "integer", "description": "Number of times a migration step has failed and been recorded.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "lastError": { "type": "string", "description": "Reason the most recent migration step failed, empty while none has.", - "x-example": "" + "example": "" }, "lagDocuments": { "type": "integer", "description": "Number of documents still pending replication to the target.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "verifiedAt": { "type": "string", "description": "Time the migrated data was verified against the source in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "cutoverAt": { "type": "string", "description": "Time routing was flipped to the target in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "soakUntil": { "type": "string", "description": "Time the post-cutover soak window ends in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "autoCutover": { "type": "boolean", "description": "Whether the migration cuts over automatically once ready. Set when the migration is created and never changed afterwards, so it always reports what was asked for.", - "x-example": true + "example": true }, "cutoverRequested": { "type": "boolean", "description": "Whether a cutover has been requested and not yet attempted. Set by the cutover endpoint and cleared when the attempt is made, so a cutover that fails a check parks the migration again rather than retrying on its own.", - "x-example": false + "example": false }, "paused": { "type": "boolean", "description": "Whether the migration is paused.", - "x-example": false + "example": false } }, "required": [ @@ -115466,173 +115351,173 @@ "$id": { "type": "string", "description": "Dedicated database ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Database creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Database update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "projectId": { "type": "string", "description": "Project ID that owns this database.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Database display name.", - "x-example": "My Production Database" + "example": "My Production Database" }, "api": { "type": "string", "description": "Product API that owns this database: tablesdb, documentsdb, vectorsdb, mysql, postgresql, or mongodb.", - "x-example": "postgresql" + "example": "postgresql" }, "engine": { "type": "string", "description": "Database engine: postgresql, mysql, or mongodb. Null until the backing reports one.", - "x-example": "postgresql" + "example": "postgresql" }, "version": { "type": "string", "description": "Database engine version.", - "x-example": "16" + "example": "16" }, "specification": { "type": "string", "description": "Specification identifier.", - "x-example": "s-2vcpu-2gb" + "example": "s-2vcpu-2gb" }, "backend": { "type": "string", "description": "Database backend provider. Possible values: prisma, edge.", - "x-example": "edge" + "example": "edge" }, "hostname": { "type": "string", "description": "Database hostname for connections.", - "x-example": "db-myproject-mydb.fra.appwrite.center" + "example": "db-myproject-mydb.fra.appwrite.center" }, "connectionPort": { "type": "integer", "description": "Database port for connections. Derived from the engine when the backing has not reported one yet.", - "x-example": 5432, - "format": "int32" + "format": "int32", + "example": 5432 }, "connectionUser": { "type": "string", "description": "Database username for connections.", - "x-example": "appwrite_user" + "example": "appwrite_user" }, "connectionPassword": { "type": "string", "description": "Database password for connections.", - "x-example": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022" + "example": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022" }, "connectionString": { "type": "string", "description": "Full database connection string (URI format).", - "x-example": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.center:5432\/postgres?sslmode=require" + "example": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.center:5432\/postgres?sslmode=require" }, "ssl": { "type": "boolean", "description": "Whether SSL\/TLS is required for client connections.", - "x-example": true + "example": true }, "status": { "type": "string", "description": "Database status. Possible values: provisioning, ready, inactive, paused, failed, deleted, restoring, scaling.", - "x-example": "ready" + "example": "ready" }, "containerStatus": { "type": "string", "description": "Container status for lifecycle-managed database runtimes: active or inactive.", - "x-example": "active" + "example": "active" }, "lastAccessedAt": { "type": "string", "description": "Last activity timestamp in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "idleUntil": { "type": "string", "description": "Display-only timestamp when the database is expected to be considered idle (ISO 8601 format). Derived from last activity; lifecycle transitions are driven by lifecycleState.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "lifecycleState": { "type": "string", "description": "Idle-lifecycle state of the database. Possible values: active, warm, cold, hibernated.", - "x-example": "active" + "example": "active" }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes of inactivity before container scales to zero.", - "x-example": 15, - "format": "int32" + "format": "int32", + "example": 15 }, "cpu": { "type": "integer", "description": "CPU allocated in millicores.", - "x-example": 2000, - "format": "int32" + "format": "int32", + "example": 2000 }, "memory": { "type": "integer", "description": "Memory allocated in MB.", - "x-example": 4096, - "format": "int32" + "format": "int32", + "example": 4096 }, "storage": { "type": "integer", "description": "Storage allocated in GB.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "storageClass": { "type": "string", "description": "Storage class. Currently always 'ssd'; DigitalOcean exposes a single block-storage class.", - "x-example": "ssd" + "example": "ssd" }, "storageMaxGb": { "type": "integer", "description": "Maximum storage allowed in GB. 0 means use system default.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "nodePool": { "type": "string", "description": "Kubernetes node pool where the database is scheduled.", - "x-example": "db-pool-4vcpu-8gb" + "example": "db-pool-4vcpu-8gb" }, "replicas": { "type": "integer", "description": "Number of high availability replicas. High availability is enabled when greater than 0.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "syncMode": { "type": "string", "description": "Replication sync mode: async, sync, or quorum.", - "x-example": "async" + "example": "async" }, "networkMaxConnections": { "type": "integer", "description": "Maximum concurrent client connections. This is the limit a client pool may reach; the engine's own max_connections reported by the status endpoint is a smaller backend limit the pooler multiplexes onto and does not constrain a client pool.", - "x-example": 500, - "format": "int32" + "format": "int32", + "example": 500 }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds.", - "x-example": 900, - "format": "int32" + "format": "int32", + "example": 900 }, "networkIPAllowlist": { "type": "array", @@ -115640,7 +115525,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "10.0.0.0\/8", "192.168.1.0\/24" ] @@ -115648,56 +115533,56 @@ "backupEnabled": { "type": "boolean", "description": "Whether automatic backups are enabled.", - "x-example": true + "example": true }, "pitr": { "type": "boolean", "description": "Whether point-in-time recovery is enabled.", - "x-example": true + "example": true }, "pitrRetentionDays": { "type": "integer", "description": "Number of days to retain PITR data.", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "storageAutoscaling": { "type": "boolean", "description": "Whether automatic storage expansion is enabled.", - "x-example": true + "example": true }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage that triggers automatic expansion.", - "x-example": 85, - "format": "int32" + "format": "int32", + "example": 85 }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", - "x-example": 500, - "format": "int32" + "format": "int32", + "example": 500 }, "maintenanceWindowDay": { "type": "string", "description": "Day of the week for the maintenance window. Possible values: sun, mon, tue, wed, thu, fri, sat.", - "x-example": "sun" + "example": "sun" }, "maintenanceWindowHourUtc": { "type": "integer", "description": "Hour in UTC (0-23) when the maintenance window starts.", - "x-example": 3, - "format": "int32" + "format": "int32", + "example": 3 }, "metricsEnabled": { "type": "boolean", "description": "Whether metrics collection is enabled.", - "x-example": false + "example": false }, "sqlApiEnabled": { "type": "boolean", "description": "Whether the SQL API sidecar is enabled for this database.", - "x-example": true + "example": true }, "sqlApiAllowedStatements": { "type": "array", @@ -115705,30 +115590,32 @@ "items": { "type": "string" }, - "x-example": "SELECT" + "example": [ + "SELECT" + ] }, "sqlApiMaxRows": { "type": "integer", "description": "Maximum rows returned per SQL API execution. Results larger than this are truncated.", - "x-example": 10000, - "format": "int32" + "format": "int32", + "example": 10000 }, "sqlApiMaxBytes": { "type": "integer", "description": "Maximum serialised SQL API result payload in bytes. Results larger than this are truncated.", - "x-example": 10485760, - "format": "int32" + "format": "int32", + "example": 10485760 }, "sqlApiTimeoutSeconds": { "type": "integer", "description": "Maximum server-side SQL API execution time in seconds before the query is cancelled.", - "x-example": 30, - "format": "int32" + "format": "int32", + "example": 30 }, "error": { "type": "string", "description": "Error message if status is failed.", - "x-example": "" + "example": "" } }, "required": [ @@ -115838,10 +115725,12 @@ "type": "object", "properties": { "rows": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "Result rows as a list of column-name => value maps. Empty for non-returning statements.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "id": 1, "name": "example" @@ -115851,8 +115740,8 @@ "rowCount": { "type": "integer", "description": "Number of rows returned (for SELECT) or affected (for INSERT\/UPDATE\/DELETE).", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "columns": { "type": "array", @@ -115860,24 +115749,24 @@ "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseExecutionColumn" }, - "x-example": [] + "example": [] }, "durationMs": { "type": "integer", "description": "Server-side execution time in milliseconds.", - "x-example": 12, - "format": "int32" + "format": "int32", + "example": 12 }, "truncated": { "type": "boolean", "description": "True when the configured row or byte cap was hit and the result was truncated.", - "x-example": false + "example": false }, "bytes": { "type": "integer", "description": "Serialised payload size in bytes.", - "x-example": 1024, - "format": "int32" + "format": "int32", + "example": 1024 } }, "required": [ @@ -115909,12 +115798,12 @@ "name": { "type": "string", "description": "Column name as returned by the database.", - "x-example": "id" + "example": "id" }, "type": { "type": "string", "description": "Engine-specific column type (e.g. int4, text, timestamptz).", - "x-example": "int4" + "example": "int4" } }, "required": [ @@ -115933,62 +115822,62 @@ "$id": { "type": "string", "description": "Restoration ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Restoration creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "databaseId": { "type": "string", "description": "Database ID being restored into.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "sourceDatabaseId": { "type": "string", "description": "Source database ID when restoring a backup into another database.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "backupId": { "type": "string", "description": "Backup ID used for restoration (null for PITR).", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "type": { "type": "string", "description": "Restoration type. Possible values: backup (restore from a specific backup snapshot), pitr (point-in-time recovery to a specific timestamp).", - "x-example": "backup" + "example": "backup" }, "status": { "type": "string", "description": "Restoration status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error).", - "x-example": "completed" + "example": "completed" }, "targetTime": { "type": "string", "description": "Target time for PITR restoration in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "startedAt": { "type": "string", "description": "Restoration start time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "completedAt": { "type": "string", "description": "Restoration completion time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "error": { "type": "string", "description": "Error message if restoration failed.", - "x-example": "" + "example": "" } }, "required": [ @@ -116027,33 +115916,33 @@ "health": { "type": "string", "description": "Overall health status: healthy, degraded, unhealthy, or unknown when nothing could be measured.", - "x-example": "healthy" + "example": "healthy" }, "ready": { "type": "boolean", "description": "Whether the database is ready to accept connections.", - "x-example": true + "example": true }, "engine": { "type": "string", "description": "Database engine: postgresql, mysql, or mongodb.", - "x-example": "postgresql" + "example": "postgresql" }, "version": { "type": "string", "description": "Database engine version.", - "x-example": "17" + "example": "17" }, "uptime": { "type": "integer", "description": "Database uptime in seconds.", - "x-example": 86400, - "format": "int32" + "format": "int32", + "example": 86400 }, "connections": { "type": "object", "description": "Connection statistics.", - "x-example": { + "example": { "current": 12, "max": 100 }, @@ -116066,35 +115955,35 @@ "syncMode": { "type": "string", "description": "Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.", - "x-example": "async" + "example": "async" }, "effectiveSyncMode": { "type": "string", "description": "Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read.", - "x-example": "async", + "example": "async", "nullable": true }, "syncDegraded": { "type": "boolean", "description": "Whether the enforced replication is weaker than the requested syncMode.", - "x-example": false + "example": false }, "syncAcknowledgements": { "type": "integer", "description": "Number of standby acknowledgements the primary waits for before a write is committed.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "syncStandbyCount": { "type": "integer", "description": "Number of standbys registered with the primary for synchronous replication.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "syncStateConfirmed": { "type": "boolean", "description": "Whether the other sync fields are an engine reading rather than a recorded estimate. True when the primary answered what it is enforcing, including when that answer contradicted the record, in which case the contradicted values are replaced by the ones the engine reports. False when the reading could not be taken: the probe did not answer, there was no engine to ask, or the values describe a configuration change just applied rather than anything measured. Absent when no engine was asked at all, so an unprobed database is distinguishable from an unconfirmed one. False never means a standby was found lagging, because it is the absence of a reading rather than a negative one, so draw no conclusion about replication health from it or from a response that omits it.", - "x-example": true, + "example": true, "nullable": true }, "replicas": { @@ -116103,7 +115992,7 @@ "items": { "$ref": "#\/components\/schemas\/databaseStatusReplica" }, - "x-example": [ + "example": [ { "index": 0, "role": "primary", @@ -116126,14 +116015,16 @@ "items": { "$ref": "#\/components\/schemas\/databaseStatusVolume" }, - "x-example": { - "data": { - "path": "\/var\/lib\/postgresql\/data", - "usedPercent": "45%", - "available": "55GB", - "mounted": true + "example": [ + { + "data": { + "path": "\/var\/lib\/postgresql\/data", + "usedPercent": "45%", + "available": "55GB", + "mounted": true + } } - } + ] } }, "required": [ @@ -116199,66 +116090,66 @@ "$id": { "type": "string", "description": "DNS Record ID.", - "x-example": "5f40a6e10c65e" + "example": "5f40a6e10c65e" }, "$createdAt": { "type": "string", "description": "DNS Record creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "DNS Record update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "type": { "type": "string", "description": "DNS record type (e.g. A, CNAME, MX).", - "x-example": "A" + "example": "A" }, "name": { "type": "string", "description": "Record name or subdomain.", - "x-example": "mail" + "example": "mail" }, "value": { "type": "string", "description": "Value of the record (IP address, domain, etc.).", - "x-example": "192.0.2.1" + "example": "192.0.2.1" }, "ttl": { "type": "integer", "description": "Time to live (in seconds).", - "x-example": 86400, - "format": "int32" + "format": "int32", + "example": 86400 }, "priority": { "type": "integer", "description": "Record priority (commonly used for MX).", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 }, "lock": { "type": "boolean", "description": "Whether this record is locked (read-only).", - "x-example": false + "example": false }, "weight": { "type": "integer", "description": "Record weight (used for SRV records).", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 }, "port": { "type": "integer", "description": "Target port (used for SRV records).", - "x-example": 443, - "format": "int32" + "format": "int32", + "example": 443 }, "comment": { "type": "string", "description": "Comment for the DNS record.", - "x-example": "Mail server record" + "example": "Mail server record" } }, "required": [ @@ -116297,58 +116188,58 @@ "$id": { "type": "string", "description": "Domain ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Domain creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Domain update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "domain": { "type": "string", "description": "Domain name.", - "x-example": "example.com" + "example": "example.com" }, "registrar": { "type": "string", "description": "Domain registrar (e.g. \"appwrite\" or \"third_party\").", - "x-example": "appwrite" + "example": "appwrite" }, "nameservers": { "type": "string", "description": "Nameservers setting. \"Appwrite\" or empty string.", - "x-example": "Appwrite" + "example": "Appwrite" }, "expire": { "type": "string", "description": "Domain expiry date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "renewal": { "type": "string", "description": "Domain renewal date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "autoRenewal": { "type": "boolean", "description": "If set to true, the domain will automatically renew.", - "x-example": true + "example": true }, "renewalPrice": { "type": "integer", "description": "Renewal price (in cents).", - "x-example": 2599, - "format": "int32" + "format": "int32", + "example": 2599 }, "transferStatus": { "type": "string", "description": "Transfer status for domains being transferred in. Null when the domain is not being transferred.", - "x-example": "pending_registry", + "example": "pending_registry", "enum": [ "transferrable", "not_transferrable", @@ -116365,7 +116256,7 @@ "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "dnsRecords": { "type": "array", @@ -116373,7 +116264,7 @@ "items": { "$ref": "#\/components\/schemas\/dnsRecord" }, - "x-example": [] + "example": [] } }, "required": [ @@ -116413,34 +116304,34 @@ "domain": { "type": "string", "description": "Domain name.", - "x-example": "example.com" + "example": "example.com" }, "tld": { "type": "string", "description": "Top-level domain for the requested domain.", - "x-example": "com" + "example": "com" }, "available": { "type": "boolean", "description": "Whether the domain is currently available for registration.", - "x-example": true + "example": true }, "price": { "type": "number", "description": "Domain registration price.", - "x-example": 25.99, - "format": "double" + "format": "double", + "example": 25.99 }, "periodYears": { "type": "integer", "description": "Price period in years.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "premium": { "type": "boolean", "description": "Whether the domain is a premium domain.", - "x-example": false + "example": false } }, "required": [ @@ -116467,37 +116358,37 @@ "$id": { "type": "string", "description": "Purchase\/invoice ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Purchase creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Purchase update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "domainId": { "type": "string", "description": "Domain document ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "domain": { "type": "string", "description": "Domain name.", - "x-example": "example.com" + "example": "example.com" }, "organizationId": { "type": "string", "description": "Team ID that owns the domain.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "status": { "type": "string", "description": "Domain purchase status.", - "x-example": "pending", + "example": "pending", "enum": [ "pending", "succeeded", @@ -116509,18 +116400,18 @@ "clientSecret": { "type": "string", "description": "Stripe client secret for 3DS; empty when not applicable.", - "x-example": "" + "example": "" }, "amount": { "type": "number", "description": "Purchase amount.", - "x-example": 25.99, - "format": "double" + "format": "double", + "example": 25.99 }, "currency": { "type": "string", "description": "Currency code.", - "x-example": "USD" + "example": "USD" } }, "required": [ @@ -116555,24 +116446,24 @@ "domain": { "type": "string", "description": "Domain suggestion.", - "x-example": "example.com" + "example": "example.com" }, "premium": { "type": "boolean", "description": "Is the domain premium?", - "x-example": true + "example": true }, "price": { "type": "number", "description": "Domain price.", - "x-example": 25.99, "format": "double", + "example": 25.99, "nullable": true }, "available": { "type": "boolean", "description": "Is the domain available?", - "x-example": true + "example": true } }, "required": [ @@ -116594,7 +116485,7 @@ "authCode": { "type": "string", "description": "Domain transfer authorization code.", - "x-example": "mock_1a2b3c4d" + "example": "mock_1a2b3c4d" } }, "required": [ @@ -116611,7 +116502,7 @@ "status": { "type": "string", "description": "Transfer status.", - "x-example": "pending_registry", + "example": "pending_registry", "enum": [ "transferrable", "not_transferrable", @@ -116627,12 +116518,12 @@ "reason": { "type": "string", "description": "Additional transfer status information.", - "x-example": "Transfer in progress" + "example": "Transfer in progress" }, "timestamp": { "type": "string", "description": "Transfer status timestamp in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -116653,52 +116544,52 @@ "$id": { "type": "string", "description": "Feedback ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Feedback creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Feedback update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "title": { "type": "string", "description": "Feedback reason", - "x-example": "I encountered a bug and outage that caused my app to lose its value" + "example": "I encountered a bug and outage that caused my app to lose its value" }, "message": { "type": "string", "description": "Feedback message", - "x-example": "The platform experienced significant downtime which affected my users." + "example": "The platform experienced significant downtime which affected my users." }, "fromPlanId": { "type": "string", "description": "Plan ID downgrading from", - "x-example": "pro" + "example": "pro" }, "toPlanId": { "type": "string", "description": "Plan ID downgrading to", - "x-example": "free" + "example": "free" }, "teamId": { "type": "string", "description": "Organization ID", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userId": { "type": "string", "description": "User ID who submitted feedback", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "version": { "type": "string", "description": "Console version", - "x-example": "1.8.0" + "example": "1.8.0" } }, "required": [ @@ -116733,26 +116624,26 @@ "amount": { "type": "number", "description": "Total amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "grossAmount": { "type": "number", "description": "Gross payable amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "discount": { "type": "number", "description": "Discount amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "credits": { "type": "number", "description": "Credits amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "items": { "type": "array", @@ -116760,7 +116651,7 @@ "items": { "$ref": "#\/components\/schemas\/estimation_item" }, - "x-example": [] + "example": [] }, "discounts": { "type": "array", @@ -116768,18 +116659,18 @@ "items": { "$ref": "#\/components\/schemas\/estimation_item" }, - "x-example": [] + "example": [] }, "trialDays": { "type": "integer", "description": "Trial days", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "trialEndDate": { "type": "string", "description": "Trial end date", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -116813,7 +116704,7 @@ "items": { "$ref": "#\/components\/schemas\/invoice" }, - "x-example": [] + "example": [] } }, "required": [ @@ -116830,13 +116721,13 @@ "label": { "type": "string", "description": "Label", - "x-example": "Plan name" + "example": "Plan name" }, "value": { "type": "number", "description": "Gross payable amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 } }, "required": [ @@ -116855,22 +116746,21 @@ "currentBillingPlanId": { "type": "string", "description": "Current billing plan ID", - "x-example": "tier-2" + "example": "tier-2" }, "targetBillingPlanId": { "type": "string", "description": "Target billing plan ID", - "x-example": "tier-0" + "example": "tier-0" }, "direction": { "type": "string", "description": "Direction of plan change: upgrade, downgrade, or same", - "x-example": "downgrade" + "example": "downgrade" }, "estimation": { "type": "object", "description": "Cost estimation details", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/planChangeEstimationDetails" @@ -116880,7 +116770,6 @@ "limits": { "type": "object", "description": "Plan limits and compliance information", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/planChangeLimits" @@ -116910,26 +116799,26 @@ "amount": { "type": "number", "description": "Total amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "grossAmount": { "type": "number", "description": "Gross payable amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "discount": { "type": "number", "description": "Discount amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "credits": { "type": "number", "description": "Credits amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "items": { "type": "array", @@ -116937,7 +116826,7 @@ "items": { "$ref": "#\/components\/schemas\/estimation_item" }, - "x-example": [] + "example": [] }, "discounts": { "type": "array", @@ -116945,25 +116834,25 @@ "items": { "$ref": "#\/components\/schemas\/estimation_item" }, - "x-example": [] + "example": [] }, "trialDays": { "type": "integer", "description": "Trial days", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "trialEndDate": { "type": "string", "description": "Trial end date", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "organizationCredits": { "type": "number", "description": "Organization's existing credits", - "x-example": 0, - "format": "double" + "format": "double", + "example": 0 } }, "required": [ @@ -116998,7 +116887,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "pgvector", "uuid-ossp" ] @@ -117009,7 +116898,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "postgis", "pg_trgm" ] @@ -117020,7 +116909,7 @@ "items": { "$ref": "#\/components\/schemas\/postgresExtension" }, - "x-example": [] + "example": [] } }, "required": [ @@ -117047,29 +116936,29 @@ "$id": { "type": "string", "description": "Member identifier.", - "x-example": "1" + "example": "1" }, "role": { "type": "string", "description": "Member role. Possible values: primary (accepts reads and writes), replica (read-only follower), unknown (placement not established; reported while a transition is moving or restarting the topology and this member has not been probed, so no member can be named the write target).", - "x-example": "replica" + "example": "replica" }, "status": { "type": "string", "description": "Member pod status. Possible values: pending (configured but absent from the backend topology, so nothing is bringing it up), provisioning (pod missing or Pending), starting (Running but not Ready), active (Running and Ready), failed (Failed phase or CrashLoopBackOff container), or the lowercased pod phase reported by the cluster.", - "x-example": "active" + "example": "active" }, "replicating": { "type": "boolean", "description": "Whether the engine reports this member's replication stream as up. Null when no reading was taken: a primary has no stream to report, and a member that is not active, or whose probe did not answer, has none yet. False is a reading and null is the absence of one, so the two are not interchangeable. Read it beside lagSeconds before expecting a failover that names no target to find a promotable standby: a member streaming at a known lag is one, and a member reporting null is not evidence either way.", - "x-example": true, + "example": true, "nullable": true }, "lagSeconds": { "type": "number", "description": "Replication lag in seconds. Null when the lag is not known: a primary has none to report, and a member the backend has not probed has none yet. Also null against `replicating: true`, for a member that is streaming but whose engine printed no numeric lag.", - "x-example": 0.5, "format": "double", + "example": 0.5, "nullable": true } }, @@ -117093,61 +116982,61 @@ "$id": { "type": "string", "description": "Operation ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Operation creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "databaseId": { "type": "string", "description": "Database ID the operation ran against.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "type": { "type": "string", "description": "Operation type, such as provision, update, restore, pausing, resuming, failover, backup-create or cross-region-enable.", - "x-example": "update" + "example": "update" }, "status": { "type": "string", "description": "Operation status. Possible values: running (in progress), completed (finished successfully), failed (ended in an error).", - "x-example": "completed" + "example": "completed" }, "attempts": { "type": "integer", "description": "Number of times this operation has been attempted.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "requestedAt": { "type": "string", "description": "Time the operation was requested, in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "startedAt": { "type": "string", "description": "Time the operation started, in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "completedAt": { "type": "string", "description": "Time the operation reached a terminal state, in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "errorCode": { "type": "string", "description": "Machine-readable failure code. `Interrupted` marks an attempt that ended before its outcome could be confirmed.", - "x-example": "Interrupted" + "example": "Interrupted" }, "errorMessage": { "type": "string", "description": "Failure message if the operation failed.", - "x-example": "" + "example": "" } }, "required": [ @@ -117181,16 +117070,15 @@ "total": { "type": "integer", "description": "Total number of operations.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "operations": { "type": "array", "description": "List of operations.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseOperation" - }, - "x-example": "" + } } }, "required": [ @@ -117209,41 +117097,41 @@ "replicas": { "type": "integer", "description": "Number of configured replicas. Zero means high availability is disabled.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "syncMode": { "type": "string", "description": "Requested replication sync mode. Possible values: async (asynchronous, fastest), sync (synchronous, strong consistency), quorum (quorum-based, majority of replicas must confirm). This is what was asked for; compare it with effectiveSyncMode for what the primary is enforcing.", - "x-example": "async" + "example": "async" }, "effectiveSyncMode": { "type": "string", "description": "Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read. A value below the requested syncMode means writes are being acknowledged with weaker durability than configured.", - "x-example": "async", + "example": "async", "nullable": true }, "syncDegraded": { "type": "boolean", "description": "Whether the enforced replication is weaker than the requested syncMode.", - "x-example": false + "example": false }, "syncAcknowledgements": { "type": "integer", "description": "Number of standby acknowledgements the primary waits for before a write is committed. Zero means writes are acknowledged locally.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "syncStandbyCount": { "type": "integer", "description": "Number of standbys registered with the primary for synchronous replication.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "syncStateConfirmed": { "type": "boolean", "description": "Whether the other sync fields are an engine reading rather than a recorded estimate. True when the primary answered what it is enforcing, including when that answer contradicted the record, in which case the contradicted values are replaced by the ones the engine reports. False when the reading could not be taken: the probe did not answer, there was no engine to ask, or the values describe a configuration change just applied rather than anything measured. Absent when no engine was asked at all, so an unprobed database is distinguishable from an unconfirmed one. False never means a standby was found lagging, because it is the absence of a reading rather than a negative one, so draw no conclusion about replication health from it or from a response that omits it.", - "x-example": true, + "example": true, "nullable": true }, "members": { @@ -117252,7 +117140,7 @@ "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseMember" }, - "x-example": [] + "example": [] } }, "required": [ @@ -117281,22 +117169,22 @@ "domain": { "type": "string", "description": "Domain name.", - "x-example": "appwrite.company.com" + "example": "appwrite.company.com" }, "type": { "type": "string", "description": "Invalidation type. Possible values are \"tag\", \"path\", or \"all\".", - "x-example": "tag" + "example": "tag" }, "reference": { "type": "string", "description": "Invalidated reference. Depending on type this is a cache tag name, a URL path, or empty when type is all.", - "x-example": "products" + "example": "products" }, "status": { "type": "string", "description": "Invalidation status.", - "x-example": "success" + "example": "success" } }, "required": [ @@ -117319,17 +117207,17 @@ "$id": { "type": "string", "description": "Invoice ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Invoice creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Invoice update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -117337,24 +117225,24 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "teamId": { "type": "string", "description": "Project ID", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "aggregationId": { "type": "string", "description": "Aggregation ID", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "plan": { "type": "string", "description": "Billing plan selected. Can be one of `tier-0`, `tier-1` or `tier-2`.", - "x-example": "tier-1" + "example": "tier-1" }, "usage": { "type": "array", @@ -117362,89 +117250,89 @@ "items": { "$ref": "#\/components\/schemas\/usageResources" }, - "x-example": [] + "example": [] }, "amount": { "type": "number", "description": "Invoice Amount", - "x-example": 50, - "format": "double" + "format": "double", + "example": 50 }, "tax": { "type": "number", "description": "Tax percentage", - "x-example": 17, - "format": "double" + "format": "double", + "example": 17 }, "taxAmount": { "type": "number", "description": "Tax amount", - "x-example": 12.5, - "format": "double" + "format": "double", + "example": 12.5 }, "vat": { "type": "number", "description": "VAT percentage", - "x-example": 17, - "format": "double" + "format": "double", + "example": 17 }, "vatAmount": { "type": "number", "description": "VAT amount", - "x-example": 12.5, - "format": "double" + "format": "double", + "example": 12.5 }, "grossAmount": { "type": "number", "description": "Gross amount after vat, tax, and discounts applied.", - "x-example": 12.5, - "format": "double" + "format": "double", + "example": 12.5 }, "creditsUsed": { "type": "number", "description": "Credits used.", - "x-example": 30, - "format": "double" + "format": "double", + "example": 30 }, "currency": { "type": "string", "description": "Currency the invoice is in", - "x-example": "USD" + "example": "USD" }, "clientSecret": { "type": "string", "description": "Client secret for processing failed payments in front-end", - "x-example": "pi_daslfasdfkla_asdkfl" + "example": "pi_daslfasdfkla_asdkfl" }, "status": { "type": "string", "description": "Invoice status", - "x-example": "succeeded" + "example": "succeeded" }, "type": { "type": "string", "description": "Invoice type. Can be one of `subscription`, `domain_purchase`, `domain_renewal`, `domain_transfer`, or `addon_*`.", - "x-example": "subscription" + "example": "subscription" }, "lastError": { "type": "string", "description": "Last payment error associated with the invoice", - "x-example": "Your card has insufficient balance." + "example": "Your card has insufficient balance." }, "dueAt": { "type": "string", "description": "Invoice due date.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "from": { "type": "string", "description": "Beginning date of the invoice", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "to": { "type": "string", "description": "End date of the invoice", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -117507,33 +117395,33 @@ "$id": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Team creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Team update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Team name.", - "x-example": "VIP" + "example": "VIP" }, "total": { "type": "integer", "description": "Total number of team members.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "prefs": { "type": "object", "description": "Team preferences as a key-value object", - "x-example": { + "example": { "theme": "pink", "timezone": "UTC" }, @@ -117546,8 +117434,8 @@ "billingBudget": { "type": "integer", "description": "Project budget limit. Null when no budget is set.", - "x-example": 50, "format": "int32", + "example": 50, "nullable": true }, "budgetAlerts": { @@ -117557,7 +117445,7 @@ "type": "integer", "format": "int32" }, - "x-example": [ + "example": [ 50, 75 ] @@ -117565,17 +117453,16 @@ "billingPlan": { "type": "string", "description": "Organization's billing plan ID.", - "x-example": "tier-1" + "example": "tier-1" }, "billingPlanId": { "type": "string", "description": "Organization's billing plan ID.", - "x-example": "tier-1" + "example": "tier-1" }, "billingPlanDetails": { "type": "object", "description": "Organization's billing plan.", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlan" @@ -117585,107 +117472,106 @@ "billingEmail": { "type": "string", "description": "Billing email set for the organization.", - "x-example": "billing@org.example" + "example": "billing@org.example" }, "billingStartDate": { "type": "string", "description": "Billing cycle start date.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "billingCurrentInvoiceDate": { "type": "string", "description": "Current invoice cycle start date.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "billingNextInvoiceDate": { "type": "string", "description": "Next invoice cycle start date.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "billingTrialStartDate": { "type": "string", "description": "Start date of trial.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "billingTrialDays": { "type": "integer", "description": "Number of trial days.", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "billingAggregationId": { "type": "string", "description": "Current active aggregation id.", - "x-example": "adbc3de4rddfsd" + "example": "adbc3de4rddfsd" }, "billingInvoiceId": { "type": "string", "description": "Current active aggregation id.", - "x-example": "adbc3de4rddfsd" + "example": "adbc3de4rddfsd" }, "paymentMethodId": { "type": "string", "description": "Default payment method.", - "x-example": "adbc3de4rddfsd" + "example": "adbc3de4rddfsd" }, "billingAddressId": { "type": "string", "description": "Default payment method.", - "x-example": "adbc3de4rddfsd", + "example": "adbc3de4rddfsd", "nullable": true }, "backupPaymentMethodId": { "type": "string", "description": "Backup payment method.", - "x-example": "adbc3de4rddfsd", + "example": "adbc3de4rddfsd", "nullable": true }, "status": { "type": "string", "description": "Team status.", - "x-example": "active" + "example": "active" }, "remarks": { "type": "string", "description": "Remarks on team status.", - "x-example": "Pending initial payment", + "example": "Pending initial payment", "nullable": true }, "agreementBAA": { "type": "string", "description": "Organization agreements", - "x-example": "", + "example": "", "nullable": true }, "programManagerName": { "type": "string", "description": "Program manager's name.", - "x-example": "", + "example": "", "nullable": true }, "programManagerCalendar": { "type": "string", "description": "Program manager's calendar link.", - "x-example": "", + "example": "", "nullable": true }, "programDiscordChannelName": { "type": "string", "description": "Program's discord channel name.", - "x-example": "", + "example": "", "nullable": true }, "programDiscordChannelUrl": { "type": "string", "description": "Program's discord channel URL.", - "x-example": "", + "example": "", "nullable": true }, "billingLimits": { "type": "object", "description": "Billing limits reached", - "x-example": "", "allOf": [ { "$ref": "#\/components\/schemas\/billingLimits" @@ -117696,32 +117582,30 @@ "billingPlanDowngrade": { "type": "string", "description": "Billing plan selected for downgrade.", - "x-example": "tier-1", + "example": "tier-1", "nullable": true }, "billingTaxId": { "type": "string", "description": "Tax Id", - "x-example": "", + "example": "", "nullable": true }, "markedForDeletion": { "type": "boolean", - "description": "Marked for deletion", - "x-example": "" + "description": "Marked for deletion" }, "platform": { "type": "string", "description": "Product with which the organization is associated (appwrite or imagine)", - "x-example": "imagine" + "example": "imagine" }, "projects": { "type": "array", "description": "Selected projects", "items": { "type": "string" - }, - "x-example": "" + } } }, "required": [ @@ -117799,32 +117683,32 @@ "message": { "type": "string", "description": "Message for the end user to show on Console.", - "x-example": "" + "example": "" }, "clientSecret": { "type": "string", "description": "Stripe client secret to use for validation.", - "x-example": "" + "example": "" }, "organizationId": { "type": "string", "description": "Organization ID for which the payment authentication is needed.", - "x-example": "" + "example": "" }, "invoiceId": { "type": "string", "description": "Invoice ID against which the payment needs to be validated.", - "x-example": "" + "example": "" }, "addonId": { "type": "string", "description": "Addon ID to use when calling the addon validate endpoint. Empty when authentication is not for an addon.", - "x-example": "" + "example": "" }, "projectId": { "type": "string", "description": "Project ID for project-level addon payments. Empty for organization-level addons.", - "x-example": "" + "example": "" } }, "required": [ @@ -117851,17 +117735,17 @@ "$id": { "type": "string", "description": "Payment Method ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Payment method creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Payment method update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -117869,91 +117753,91 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "providerMethodId": { "type": "string", "description": "Payment method ID from the payment provider", - "x-example": "abdk3ed3sdkfj" + "example": "abdk3ed3sdkfj" }, "clientSecret": { "type": "string", "description": "Client secret hash for payment setup", - "x-example": "seti_ddfe" + "example": "seti_ddfe" }, "providerUserId": { "type": "string", "description": "User ID from the payment provider.", - "x-example": "abdk3ed3sdkfj" + "example": "abdk3ed3sdkfj" }, "userId": { "type": "string", "description": "ID of the Team.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "expiryMonth": { "type": "integer", "description": "Expiry month of the payment method.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "expiryYear": { "type": "integer", "description": "Expiry year of the payment method.", - "x-example": 2024, - "format": "int32" + "format": "int32", + "example": 2024 }, "last4": { "type": "string", "description": "Last 4 digit of the payment method", - "x-example": "4242" + "example": "4242" }, "brand": { "type": "string", "description": "Payment method brand", - "x-example": "visa" + "example": "visa" }, "name": { "type": "string", "description": "Name of the owner", - "x-example": "John Doe" + "example": "John Doe" }, "mandateId": { "type": "string", "description": "Mandate ID of the payment method", - "x-example": "yxc" + "example": "yxc" }, "country": { "type": "string", "description": "Country of the payment method", - "x-example": "de" + "example": "de" }, "state": { "type": "string", "description": "State of the payment method", - "x-example": "" + "example": "" }, "lastError": { "type": "string", "description": "Last payment error associated with the payment method.", - "x-example": "Your card has insufficient funds." + "example": "Your card has insufficient funds." }, "default": { "type": "boolean", "description": "True when it's the default payment method.", - "x-example": false + "example": false }, "expired": { "type": "boolean", "description": "True when payment method has expired.", - "x-example": false + "example": false }, "failed": { "type": "boolean", "description": "True when payment method has failed to process multiple times.", - "x-example": false + "example": false } }, "required": [ @@ -118010,12 +117894,12 @@ "earliest": { "type": "string", "description": "Earliest available recovery point.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "latest": { "type": "string", "description": "Latest available recovery point.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -118034,48 +117918,50 @@ "currency": { "type": "string", "description": "Currency code", - "x-example": "USD" + "example": "USD" }, "grossAmount": { "type": "number", "description": "Gross amount after all discounts and credits", - "x-example": 15, - "format": "double" + "format": "double", + "example": 15 }, "credits": { "type": "number", "description": "Credits applied from coupon", - "x-example": 0, - "format": "double" + "format": "double", + "example": 0 }, "organizationCredits": { "type": "number", "description": "Organization's existing credits applied", - "x-example": 5, - "format": "double" + "format": "double", + "example": 5 }, "discount": { "type": "number", "description": "Discount amount from prorated invoices", - "x-example": 0, - "format": "double" + "format": "double", + "example": 0 }, "amount": { "type": "number", "description": "Total amount before discounts and credits", - "x-example": 20, - "format": "double" + "format": "double", + "example": 20 }, "nextInvoiceDate": { "type": "string", "description": "Next invoice date", - "x-example": "2025-12-01T00:00:00.000Z" + "example": "2025-12-01T00:00:00.000Z" }, "items": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "Line items breakdown", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "label": "Starter plan", "value": 0 @@ -118087,10 +117973,12 @@ ] }, "discounts": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "Applied discounts breakdown", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "label": "Organization credits", "value": 5 @@ -118142,7 +118030,7 @@ "canChangePlan": { "type": "boolean", "description": "Whether the plan change is allowed", - "x-example": false + "example": false }, "unsupportedAddons": { "type": "array", @@ -118150,14 +118038,14 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "baa" ] }, "projects": { "type": "object", "description": "Project count against the target plan limit", - "x-example": {}, + "example": {}, "allOf": [ { "$ref": "#\/components\/schemas\/planChangeResourceCompliance" @@ -118167,7 +118055,7 @@ "members": { "type": "object", "description": "Organization member count against the target plan limit", - "x-example": {}, + "example": {}, "allOf": [ { "$ref": "#\/components\/schemas\/planChangeResourceCompliance" @@ -118177,7 +118065,7 @@ "domains": { "type": "object", "description": "Custom domain count against the target plan limit", - "x-example": {}, + "example": {}, "allOf": [ { "$ref": "#\/components\/schemas\/planChangeResourceCompliance" @@ -118187,8 +118075,8 @@ "nonCompliantProjects": { "type": "integer", "description": "Number of projects exceeding target plan limits", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "projectCompliance": { "type": "array", @@ -118196,7 +118084,7 @@ "items": { "$ref": "#\/components\/schemas\/planChangeProjectCompliance" }, - "x-example": [] + "example": [] } }, "required": [ @@ -118227,17 +118115,17 @@ "$id": { "type": "string", "description": "Project ID", - "x-example": "proj_a" + "example": "proj_a" }, "name": { "type": "string", "description": "Project name", - "x-example": "Marketing Site" + "example": "Marketing Site" }, "isCompliant": { "type": "boolean", "description": "Whether the project complies with target plan limits", - "x-example": false + "example": false }, "resources": { "type": "array", @@ -118245,12 +118133,12 @@ "items": { "$ref": "#\/components\/schemas\/planChangeResourceCompliance" }, - "x-example": [] + "example": [] }, "error": { "type": "string", "description": "Failure reason when compliance could not be evaluated. Present only when the project DB or Regions API was unreachable; in that case `isCompliant` is false (fail closed) and `resources` is empty.", - "x-example": "Failed to get project compliance from Regions API. Status: 500", + "example": "Failed to get project compliance from Regions API. Status: 500", "nullable": true } }, @@ -118275,35 +118163,35 @@ "type": { "type": "string", "description": "Resource type", - "x-example": "databases" + "example": "databases" }, "currentUsage": { "type": "integer", "description": "Current usage count", - "x-example": 3, - "format": "int32" + "format": "int32", + "example": 3 }, "limit": { "type": "integer", "description": "Allowed limit in target plan", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "status": { "type": "string", "description": "Compliance status. Either `over_limit` or `within_limit`.", - "x-example": "over_limit" + "example": "over_limit" }, "excess": { "type": "integer", "description": "Number of resources exceeding the limit", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "resolutionHint": { "type": "string", "description": "Suggestion for resolving the compliance issue. Empty when the resource is within limits.", - "x-example": "Delete or migrate 2 databases." + "example": "Delete or migrate 2 databases." } }, "required": [ @@ -118330,22 +118218,22 @@ "$id": { "type": "string", "description": "Backup policy ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Backup policy name.", - "x-example": "Hourly backups" + "example": "Hourly backups" }, "$createdAt": { "type": "string", "description": "Policy creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Policy update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "services": { "type": "array", @@ -118353,7 +118241,9 @@ "items": { "type": "string" }, - "x-example": "['databases', 'storage']" + "example": [ + "['databases', 'storage']" + ] }, "resources": { "type": "array", @@ -118361,40 +118251,42 @@ "items": { "type": "string" }, - "x-example": "['databases', 'collections', 'attributes', 'indexes']" + "example": [ + "['databases', 'collections', 'attributes', 'indexes']" + ] }, "resourceId": { "type": "string", "description": "The resource ID to backup. Set only if this policy should backup a single resource.", - "x-example": "DB1", + "example": "DB1", "nullable": true }, "resourceType": { "type": "string", "description": "The resource type to backup. Set only if this policy should backup a single resource.", - "x-example": "database", + "example": "database", "nullable": true }, "retention": { "type": "integer", "description": "How many days to keep the backup before it will be automatically deleted.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "schedule": { "type": "string", "description": "Policy backup schedule in CRON format.", - "x-example": "0 * * * *" + "example": "0 * * * *" }, "type": { "type": "string", "description": "Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup).", - "x-example": "full" + "example": "full" }, "enabled": { "type": "boolean", "description": "Is this policy enabled.", - "x-example": true + "example": true } }, "required": [ @@ -118431,12 +118323,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether the deny aliased email policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -118455,12 +118347,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether the deny disposable email policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -118479,12 +118371,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether the deny free email policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -118503,12 +118395,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether the deny non-corporate email policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -118527,55 +118419,55 @@ "enabled": { "type": "boolean", "description": "Whether connection pooling is enabled.", - "x-example": true + "example": true }, "mode": { "type": "string", "description": "Connection pool mode. Possible values: transaction (releases connections back to pool after each transaction), session (holds connections for the entire client session).", - "x-example": "transaction" + "example": "transaction" }, "maxConnections": { "type": "integer", "description": "Client-connection ceiling the pooler accepts. Enforced on MySQL and MariaDB; on PostgreSQL the pooler has no client cap, so this reports the database's advertised networkMaxConnections and cannot be set here.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 }, "defaultPoolSize": { "type": "integer", "description": "Default pool size per user.", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "port": { "type": "integer", "description": "Pooler listening port.", - "x-example": 6432, - "format": "int32" + "format": "int32", + "example": 6432 }, "readWriteSplitting": { "type": "boolean", "description": "Whether SELECTs are routed to HA replicas while writes and locked reads stay on the primary. Active only when HA is enabled.", - "x-example": true + "example": true }, "poolerCpuRequest": { "type": "string", "description": "Effective CPU request applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (5% of DB CPU, floor 100m) unless overridden.", - "x-example": "100m" + "example": "100m" }, "poolerCpuLimit": { "type": "string", "description": "Effective CPU limit applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (10% of DB CPU, floor 200m) unless overridden.", - "x-example": "200m" + "example": "200m" }, "poolerMemoryRequest": { "type": "string", "description": "Effective memory request applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (7.5% of DB memory, floor 64Mi) unless overridden.", - "x-example": "64Mi" + "example": "64Mi" }, "poolerMemoryLimit": { "type": "string", "description": "Effective memory limit applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (15% of DB memory, floor 128Mi) unless overridden.", - "x-example": "128Mi" + "example": "128Mi" } }, "required": [ @@ -118610,22 +118502,22 @@ "key": { "type": "string", "description": "Extension key used with CREATE EXTENSION.", - "x-example": "vector" + "example": "vector" }, "name": { "type": "string", "description": "Human-readable extension name.", - "x-example": "pgvector" + "example": "pgvector" }, "description": { "type": "string", "description": "Short description of what the extension provides.", - "x-example": "Vector data type and similarity search for embeddings." + "example": "Vector data type and similarity search for embeddings." }, "category": { "type": "string", "description": "Category the extension belongs to.", - "x-example": "search" + "example": "search" } }, "required": [ @@ -118648,47 +118540,45 @@ "$id": { "type": "string", "description": "Program ID", - "x-example": "" + "example": "" }, "title": { "type": "string", "description": "Program title", - "x-example": "" + "example": "" }, "description": { "type": "string", "description": "Program description", - "x-example": "" + "example": "" }, "tag": { "type": "string", - "description": "Program tag for highlighting on console", - "x-example": null + "description": "Program tag for highlighting on console" }, "icon": { "type": "string", - "description": "Program icon for highlighting on console", - "x-example": null + "description": "Program icon for highlighting on console" }, "url": { "type": "string", "description": "URL for more information on this program", - "x-example": "" + "example": "" }, "active": { "type": "boolean", "description": "Whether this program is active", - "x-example": false + "example": false }, "external": { "type": "boolean", "description": "Whether this program is external", - "x-example": false + "example": false }, "billingPlanId": { "type": "string", "description": "Billing plan ID that this is program is associated with.", - "x-example": "" + "example": "" } }, "required": [ @@ -118721,33 +118611,33 @@ "$id": { "type": "string", "description": "Region ID", - "x-example": "eu-fr" + "example": "eu-fr" }, "name": { "type": "string", "description": "Region name", - "x-example": "EU (Frankfurt)" + "example": "EU (Frankfurt)" }, "available": { "type": "boolean", "description": "Does the organization have access to this region. Null when access has not been resolved.", - "x-example": false, + "example": false, "nullable": true }, "disabled": { "type": "boolean", "description": "Does the backend support this region.", - "x-example": false + "example": false }, "default": { "type": "boolean", "description": "Is this the region default.", - "x-example": true + "example": true }, "flag": { "type": "string", "description": "Region flag code.", - "x-example": "fr" + "example": "fr" } }, "required": [ @@ -118773,42 +118663,42 @@ "$id": { "type": "string", "description": "Restoration ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Restoration creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Restoration update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "archiveId": { "type": "string", "description": "Backup archive ID.", - "x-example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7" }, "policyId": { "type": "string", "description": "Backup policy ID.", - "x-example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7" }, "status": { "type": "string", "description": "The status of the restoration. Possible values: pending, downloading, processing, completed, failed.", - "x-example": "completed" + "example": "completed" }, "startedAt": { "type": "string", "description": "The backup start time.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "migrationId": { "type": "string", "description": "Migration ID.", - "x-example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7" }, "services": { "type": "array", @@ -118816,7 +118706,9 @@ "items": { "type": "string" }, - "x-example": "['databases', 'storage']" + "example": [ + "['databases', 'storage']" + ] }, "resources": { "type": "array", @@ -118824,12 +118716,14 @@ "items": { "type": "string" }, - "x-example": "['databases', 'collections', 'attributes', 'indexes']" + "example": [ + "['databases', 'collections', 'attributes', 'indexes']" + ] }, "options": { "type": "string", "description": "Optional data in key-value object. ", - "x-example": "{databases.database[{oldId, newId, newName}]}" + "example": "{databases.database[{oldId, newId, newName}]}" } }, "required": [ @@ -118866,16 +118760,15 @@ "total": { "type": "integer", "description": "Total number of restorations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "restorations": { "type": "array", "description": "List of restorations.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseRestoration" - }, - "x-example": "" + } } }, "required": [ @@ -118894,22 +118787,22 @@ "name": { "type": "string", "description": "Name of user", - "x-example": "" + "example": "" }, "image": { "type": "string", "description": "Reviewer image", - "x-example": "" + "example": "" }, "description": { "type": "string", "description": "Reviewer description", - "x-example": "" + "example": "" }, "review": { "type": "string", "description": "Review", - "x-example": "" + "example": "" } }, "required": [ @@ -118935,7 +118828,9 @@ "items": { "type": "string" }, - "x-example": "users.read" + "example": [ + "users.read" + ] }, "roles": { "type": "array", @@ -118943,7 +118838,9 @@ "items": { "type": "string" }, - "x-example": "developer" + "example": [ + "developer" + ] } }, "required": [ @@ -118962,53 +118859,53 @@ "slug": { "type": "string", "description": "Specification slug. Use this value when creating a dedicated database.", - "x-example": "s-2vcpu-2gb" + "example": "s-2vcpu-2gb" }, "name": { "type": "string", "description": "Human readable specification name.", - "x-example": "Standard" + "example": "Standard" }, "price": { "type": "number", "description": "Monthly price of the specification in USD.", - "x-example": 20, - "format": "double" + "format": "double", + "example": 20 }, "cpu": { "type": "integer", "description": "Allocated CPU in millicores.", - "x-example": 2000, - "format": "int32" + "format": "int32", + "example": 2000 }, "memory": { "type": "integer", "description": "Allocated memory in MB.", - "x-example": 2048, - "format": "int32" + "format": "int32", + "example": 2048 }, "maxConnections": { "type": "integer", "description": "Maximum number of concurrent connections.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 }, "includedStorage": { "type": "integer", "description": "Included storage in GB before overage charges apply.", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "includedBandwidth": { "type": "integer", "description": "Included bandwidth in GB before overage charges apply.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 }, "enabled": { "type": "boolean", "description": "Whether the specification is available on the current plan.", - "x-example": true + "example": true } }, "required": [ @@ -119044,18 +118941,17 @@ "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseSpecification" }, - "x-example": [] + "example": [] }, "total": { "type": "integer", "description": "Total number of specifications.", - "x-example": 9, - "format": "int32" + "format": "int32", + "example": 9 }, "pricing": { "type": "object", "description": "Overage and add-on pricing shared across all specifications.", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/dedicatedDatabaseSpecificationPricing" @@ -119081,26 +118977,26 @@ "storageOverageRate": { "type": "number", "description": "Price per GB of storage above the included amount, per month, in USD.", - "x-example": 0.125, - "format": "double" + "format": "double", + "example": 0.125 }, "bandwidthOverageRate": { "type": "number", "description": "Price per GB of bandwidth above the included amount, per month, in USD.", - "x-example": 0.08, - "format": "double" + "format": "double", + "example": 0.08 }, "replicaRate": { "type": "number", "description": "High availability replica price as a fraction of the specification cost.", - "x-example": 1, - "format": "double" + "format": "double", + "example": 1 }, "pitrRate": { "type": "number", "description": "Point-in-time recovery price as a fraction of the specification cost.", - "x-example": 0.2, - "format": "double" + "format": "double", + "example": 0.2 } }, "required": [ @@ -119123,14 +119019,14 @@ "current": { "type": "integer", "description": "Current number of active connections.", - "x-example": 12, - "format": "int32" + "format": "int32", + "example": 12 }, "max": { "type": "integer", "description": "The engine's own max_connections. On a pooled database this is the backend limit the pooler multiplexes onto, not the ceiling a client pool may reach \u2014 that is networkMaxConnections on the database resource.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 } }, "required": [ @@ -119149,30 +119045,30 @@ "index": { "type": "integer", "description": "Member index within the database. Read `role` for which member accepts writes: a failover moves the primary without renumbering the indexes.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "role": { "type": "string", "description": "Member role. Possible values: primary (accepts reads and writes), replica (read-only follower), unknown (placement not established; reported while a transition is moving or restarting the topology, so no member can be named the write target).", - "x-example": "primary" + "example": "primary" }, "healthy": { "type": "boolean", "description": "Whether the replica is healthy.", - "x-example": true + "example": true }, "replicating": { "type": "boolean", "description": "Whether the engine reports this member's replication stream as up. Null when no reading was taken: a primary has no stream to report, and a member that is not healthy, or whose probe did not answer, has none yet. `healthy` is a reachability probe of the member itself and says nothing about replication, so a healthy member may still not be replicating.", - "x-example": true, + "example": true, "nullable": true }, "lagSeconds": { "type": "number", "description": "Replication lag in seconds (null for primary). Also null against `replicating: true`, for a member that is streaming but whose engine printed no numeric lag.", - "x-example": 0.2, "format": "double", + "example": 0.2, "nullable": true } }, @@ -119196,22 +119092,22 @@ "path": { "type": "string", "description": "Mount path of the volume.", - "x-example": "\/var\/lib\/postgresql\/data" + "example": "\/var\/lib\/postgresql\/data" }, "usedPercent": { "type": "string", "description": "Percentage of storage used.", - "x-example": "45%" + "example": "45%" }, "available": { "type": "string", "description": "Available storage space.", - "x-example": "55GB" + "example": "55GB" }, "mounted": { "type": "boolean", "description": "Whether the volume is mounted.", - "x-example": true + "example": true } }, "required": [ @@ -119234,7 +119130,6 @@ "bandwidth": { "type": "object", "description": "Bandwidth additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119244,7 +119139,6 @@ "executions": { "type": "object", "description": "Executions additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119254,7 +119148,6 @@ "member": { "type": "object", "description": "Member additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119265,7 +119158,6 @@ "realtime": { "type": "object", "description": "Realtime additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119275,7 +119167,6 @@ "realtimeMessages": { "type": "object", "description": "Realtime messages additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119285,7 +119176,6 @@ "realtimeBandwidth": { "type": "object", "description": "Realtime bandwidth additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119296,7 +119186,6 @@ "storage": { "type": "object", "description": "Storage additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119306,7 +119195,6 @@ "users": { "type": "object", "description": "User additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119316,7 +119204,6 @@ "GBHours": { "type": "object", "description": "GBHour additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119326,7 +119213,6 @@ "imageTransformations": { "type": "object", "description": "Image transformation additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119336,7 +119222,6 @@ "credits": { "type": "object", "description": "Credits additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -119376,174 +119261,174 @@ "time": { "type": "string", "description": "Bucket start timestamp (ISO 8601). When `interval` is omitted this is the request end time, marking the aggregate as-of moment.", - "x-example": "2026-04-09T12:00:00.000+00:00" + "example": "2026-04-09T12:00:00.000+00:00" }, "value": { "type": "number", "description": "Aggregated value for the bucket. Counters are whole numbers; gauge rates (e.g. queries per second) may be fractional.", - "x-example": 5000, - "format": "double" + "format": "double", + "example": 5000 }, "path": { "type": "string", "description": "API endpoint path when broken down by `path`.", - "x-example": "\/v1\/storage\/files", + "example": "\/v1\/storage\/files", "nullable": true }, "method": { "type": "string", "description": "HTTP method when broken down by `method`.", - "x-example": "POST", + "example": "POST", "nullable": true }, "status": { "type": "string", "description": "HTTP status code when broken down by `status`.", - "x-example": "201", + "example": "201", "nullable": true }, "service": { "type": "string", "description": "API service segment when broken down by `service`.", - "x-example": "storage", + "example": "storage", "nullable": true }, "country": { "type": "string", "description": "Country code when broken down by `country`.", - "x-example": "us", + "example": "us", "nullable": true }, "continentCode": { "type": "string", "description": "Continent code when broken down by `continentCode`.", - "x-example": "NA", + "example": "NA", "nullable": true }, "city": { "type": "string", "description": "City name when broken down by `city`.", - "x-example": "Mountain View", + "example": "Mountain View", "nullable": true }, "subdivisions": { "type": "string", "description": "Region\/state chain when broken down by `subdivisions`.", - "x-example": "California", + "example": "California", "nullable": true }, "isp": { "type": "string", "description": "Internet service provider when broken down by `isp`.", - "x-example": "Google", + "example": "Google", "nullable": true }, "autonomousSystemNumber": { "type": "string", "description": "Autonomous System Number (ASN) when broken down by `autonomousSystemNumber`.", - "x-example": "15169", + "example": "15169", "nullable": true }, "autonomousSystemOrganization": { "type": "string", "description": "Organization owning the ASN when broken down by `autonomousSystemOrganization`.", - "x-example": "GOOGLE", + "example": "GOOGLE", "nullable": true }, "connectionType": { "type": "string", "description": "Connection type (e.g. cable, cellular, corporate) when broken down by `connectionType`.", - "x-example": "cable", + "example": "cable", "nullable": true }, "connectionUsageType": { "type": "string", "description": "User type (e.g. residential, business, hosting) when broken down by `connectionUsageType`.", - "x-example": "residential", + "example": "residential", "nullable": true }, "connectionOrganization": { "type": "string", "description": "Registered organization of the IP when broken down by `connectionOrganization`.", - "x-example": "Google LLC", + "example": "Google LLC", "nullable": true }, "region": { "type": "string", "description": "Appwrite region when broken down by `region`.", - "x-example": "fra", + "example": "fra", "nullable": true }, "hostname": { "type": "string", "description": "Caller origin hostname when broken down by `hostname`.", - "x-example": "app.example.com", + "example": "app.example.com", "nullable": true }, "ip": { "type": "string", "description": "Caller IP address when broken down by `ip`.", - "x-example": "192.0.2.44", + "example": "192.0.2.44", "nullable": true }, "osName": { "type": "string", "description": "Operating system name when broken down by `osName`.", - "x-example": "iOS", + "example": "iOS", "nullable": true }, "clientType": { "type": "string", "description": "Client type when broken down by `clientType`.", - "x-example": "browser", + "example": "browser", "nullable": true }, "clientName": { "type": "string", "description": "Client name when broken down by `clientName`.", - "x-example": "Chrome", + "example": "Chrome", "nullable": true }, "sdk": { "type": "string", "description": "SDK name when broken down by `sdk`.", - "x-example": "web", + "example": "web", "nullable": true }, "sdkVersion": { "type": "string", "description": "SDK version when broken down by `sdkVersion`.", - "x-example": "14.0.0", + "example": "14.0.0", "nullable": true }, "deviceName": { "type": "string", "description": "Device classification when broken down by `deviceName`.", - "x-example": "smartphone", + "example": "smartphone", "nullable": true }, "teamId": { "type": "string", "description": "Owning team ID when broken down by `teamId`.", - "x-example": "team_abc", + "example": "team_abc", "nullable": true }, "resourceId": { "type": "string", "description": "External resource ID when broken down by `resourceId`.", - "x-example": "abc123", + "example": "abc123", "nullable": true }, "resourceType": { "type": "string", "description": "Resource type when broken down by `resourceType`.", - "x-example": "bucket", + "example": "bucket", "nullable": true }, "ordinal": { "type": "string", "description": "Node ordinal when broken down by `ordinal`. A stable per-node identity, not a role: ordinal 0 is the first member created, and a failover can leave the primary on any ordinal. Read the role from the database's replicas endpoint.", - "x-example": "0", + "example": "0", "nullable": true } }, @@ -119590,15 +119475,14 @@ "interval": { "type": "string", "description": "Time interval size (1h or 1d). Empty when the request omits `interval` \u2014 points then carry the request end time as their as-of marker.", - "x-example": "1d" + "example": "1d" }, "metrics": { "type": "array", "description": "One entry per requested metric, each carrying its own points[] time series (sums per bucket \/ dimension over time).", "items": { "$ref": "#\/components\/schemas\/usageMetric" - }, - "x-example": "" + } } }, "required": [ @@ -119617,15 +119501,14 @@ "interval": { "type": "string", "description": "Time interval size (1h or 1d). Empty when the request omits `interval` \u2014 points then carry the request end time as their as-of marker.", - "x-example": "1d" + "example": "1d" }, "metrics": { "type": "array", "description": "One entry per requested metric, each carrying its own points[] time series (latest-snapshot per bucket \/ dimension via argMax over time).", "items": { "$ref": "#\/components\/schemas\/usageMetric" - }, - "x-example": "" + } } }, "required": [ @@ -119644,15 +119527,14 @@ "metric": { "type": "string", "description": "Metric key this series describes.", - "x-example": "files.storage" + "example": "files.storage" }, "points": { "type": "array", "description": "Data points for this metric, ordered by time ascending. With `interval`, each entry is one bucket; without, each entry is one row of the dimensional or aggregate breakdown.", "items": { "$ref": "#\/components\/schemas\/usageDataPoint" - }, - "x-example": "" + } } }, "required": [ @@ -119674,7 +119556,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "users": { "type": "array", @@ -119682,7 +119564,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "executions": { "type": "array", @@ -119690,7 +119572,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "databasesReads": { "type": "array", @@ -119698,7 +119580,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "databasesWrites": { "type": "array", @@ -119706,7 +119588,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "imageTransformations": { "type": "array", @@ -119714,13 +119596,13 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "imageTransformationsTotal": { "type": "integer", "description": "Aggregated stats for total file transformations.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "screenshotsGenerated": { "type": "array", @@ -119728,97 +119610,97 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "screenshotsGeneratedTotal": { "type": "integer", "description": "Aggregated stats for total file transformations.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "usersTotal": { "type": "integer", "description": "Aggregated stats for total users.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "executionsTotal": { "type": "integer", "description": "Aggregated stats for total executions.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "executionsMBSecondsTotal": { "type": "integer", "description": "Aggregated stats for function executions in mb seconds.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "buildsMBSecondsTotal": { "type": "integer", "description": "Aggregated stats for function builds in mb seconds.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "filesStorageTotal": { "type": "integer", "description": "Aggregated stats for total file storage.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "buildsStorageTotal": { "type": "integer", "description": "Aggregated stats for total builds storage.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "deploymentsStorageTotal": { "type": "integer", "description": "Aggregated stats for total deployments storage.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "databasesStorageTotal": { "type": "integer", "description": "Aggregated stats for total databases storage.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "databasesReadsTotal": { "type": "integer", "description": "Aggregated stats for total databases reads.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "databasesWritesTotal": { "type": "integer", "description": "Aggregated stats for total databases writes.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "backupsStorageTotal": { "type": "integer", "description": "Aggregated stats for total backups storage.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "storageTotal": { "type": "integer", "description": "Aggregated stats for total storage.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "authPhoneTotal": { "type": "integer", "description": "Aggregated stats for total auth phone.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "authPhoneEstimate": { "type": "integer", "description": "Aggregated stats for total auth phone estimation.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "projects": { "type": "array", @@ -119826,7 +119708,7 @@ "items": { "$ref": "#\/components\/schemas\/usageOrganizationProject" }, - "x-example": [] + "example": [] }, "realtimeConnections": { "type": "array", @@ -119834,13 +119716,13 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "realtimeConnectionsTotal": { "type": "integer", "description": "Aggregated stats for total realtime connections.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "realtimeMessages": { "type": "array", @@ -119848,13 +119730,13 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "realtimeMessagesTotal": { "type": "integer", "description": "Aggregated stats for total realtime messages.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "realtimeBandwidth": { "type": "array", @@ -119862,13 +119744,13 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "realtimeBandwidthTotal": { "type": "integer", "description": "Aggregated stats for total realtime bandwidth.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 } }, "required": [ @@ -119943,7 +119825,7 @@ "projectId": { "type": "string", "description": "projectId", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "bandwidth": { "type": "array", @@ -119951,7 +119833,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "users": { "type": "array", @@ -119959,13 +119841,13 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "executions": { "type": "integer", "description": "Aggregated stats for function executions.", - "x-example": [], - "format": "int32" + "format": "int32", + "example": 0 }, "databasesReads": { "type": "array", @@ -119973,7 +119855,7 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "databasesWrites": { "type": "array", @@ -119981,49 +119863,49 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "executionsMBSeconds": { "type": "integer", "description": "Aggregated stats for function executions in mb seconds.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "buildsMBSeconds": { "type": "integer", "description": "Aggregated stats for function builds in mb seconds.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "storage": { "type": "integer", "description": "Aggregated stats for number of documents.", - "x-example": [], - "format": "int32" + "format": "int32", + "example": 0 }, "authPhoneTotal": { "type": "integer", "description": "Aggregated stats for phone authentication.", - "x-example": [], - "format": "int32" + "format": "int32", + "example": 0 }, "authPhoneEstimate": { "type": "number", "description": "Aggregated stats for phone authentication estimated cost.", - "x-example": [], - "format": "double" + "format": "double", + "example": 0 }, "databasesReadsTotal": { "type": "integer", "description": "Aggregated stats for total databases reads.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "databasesWritesTotal": { "type": "integer", "description": "Aggregated stats for total databases writes.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "imageTransformations": { "type": "array", @@ -120031,13 +119913,13 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "imageTransformationsTotal": { "type": "integer", "description": "Aggregated stats for total file transformations.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "screenshotsGenerated": { "type": "array", @@ -120045,31 +119927,31 @@ "items": { "$ref": "#\/components\/schemas\/metric" }, - "x-example": [] + "example": [] }, "screenshotsGeneratedTotal": { "type": "integer", "description": "Aggregated stats for total file transformations.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "realtimeConnections": { "type": "integer", "description": "Aggregated stats for realtime connections.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "realtimeMessages": { "type": "integer", "description": "Aggregated stats for realtime messages.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "realtimeBandwidth": { "type": "integer", "description": "Aggregated stats for realtime bandwidth.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 } }, "required": [ @@ -120124,45 +120006,45 @@ "name": { "type": "string", "description": "Invoice name", - "x-example": "" + "example": "" }, "value": { "type": "integer", "description": "Invoice value", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "amount": { "type": "number", "description": "Invoice amount", - "x-example": 500, - "format": "double" + "format": "double", + "example": 500 }, "rate": { "type": "number", "description": "Invoice rate", - "x-example": 12.5, - "format": "double" + "format": "double", + "example": 12.5 }, "desc": { "type": "string", "description": "Invoice description", - "x-example": "Your monthly recurring Pro plan." + "example": "Your monthly recurring Pro plan." }, "resourceId": { "type": "string", "description": "Resource ID", - "x-example": "" + "example": "" }, "type": { "type": "string", "description": "Dedicated database engine type for per-database line items (e.g. postgresql). Empty for other resources.", - "x-example": "postgresql" + "example": "postgresql" }, "specification": { "type": "string", "description": "Dedicated database specification slug for per-database line items (e.g. s-2vcpu-2gb). Empty for other resources.", - "x-example": "s-2vcpu-2gb" + "example": "s-2vcpu-2gb" } }, "required": [ @@ -120193,47 +120075,47 @@ "$id": { "type": "string", "description": "App ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "App creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "App update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Application name.", - "x-example": "My Application" + "example": "My Application" }, "description": { "type": "string", "description": "Application description shown to users during OAuth2 consent.", - "x-example": "Connect your workspace to My Application." + "example": "Connect your workspace to My Application." }, "clientUri": { "type": "string", "description": "Application homepage URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "logoUri": { "type": "string", "description": "Application logo URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/logo.png" + "example": "https:\/\/example.com\/logo.png" }, "privacyPolicyUrl": { "type": "string", "description": "Application privacy policy URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/privacy" + "example": "https:\/\/example.com\/privacy" }, "termsUrl": { "type": "string", "description": "Application terms of service URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/terms" + "example": "https:\/\/example.com\/terms" }, "contacts": { "type": "array", @@ -120241,14 +120123,14 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "support@example.com" ] }, "tagline": { "type": "string", "description": "Application tagline shown to users during OAuth2 consent.", - "x-example": "Automate your workspace." + "example": "Automate your workspace." }, "tags": { "type": "array", @@ -120256,7 +120138,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "productivity", "automation" ] @@ -120267,7 +120149,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "featured" ] }, @@ -120277,19 +120159,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/example.com\/screenshot.png" ] }, "supportUrl": { "type": "string", "description": "Application support URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/support" + "example": "https:\/\/example.com\/support" }, "dataDeletionUrl": { "type": "string", "description": "Application data deletion URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/data-deletion" + "example": "https:\/\/example.com\/data-deletion" }, "redirectUris": { "type": "array", @@ -120297,7 +120179,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/example.com\/callback" ] }, @@ -120307,34 +120189,34 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/example.com\/logged-out" ] }, "enabled": { "type": "boolean", "description": "Whether the app is enabled or not.", - "x-example": true + "example": true }, "type": { "type": "string", "description": "OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.", - "x-example": "confidential" + "example": "confidential" }, "deviceFlow": { "type": "boolean", "description": "Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).", - "x-example": false + "example": false }, "teamId": { "type": "string", "description": "ID of team that owns the application, if owned by team. Otherwise, user ID will be used.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userId": { "type": "string", "description": "ID of user who owns the application, if owned by user. Otherwise, team ID will be used.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "installationScopes": { "type": "array", @@ -120342,14 +120224,14 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "organization:organization.read" ] }, "installationRedirectUrl": { "type": "string", "description": "URL users are redirected to after creating or updating an installation of this application. Empty for no redirect.", - "x-example": "https:\/\/example.com\/setup" + "example": "https:\/\/example.com\/setup" }, "secrets": { "type": "array", @@ -120357,7 +120239,7 @@ "items": { "$ref": "#\/components\/schemas\/appSecret" }, - "x-example": [] + "example": [] } }, "required": [ @@ -120439,47 +120321,47 @@ "$id": { "type": "string", "description": "Secret ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Secret creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Secret update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "Application ID this secret belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "secret": { "type": "string", "description": "Always empty. The application client secret is returned only once, in the response of the createSecret method.", - "x-example": "" + "example": "" }, "hint": { "type": "string", "description": "Last few characters of the client secret, used to help identify it.", - "x-example": "f5c6c7" + "example": "f5c6c7" }, "createdById": { "type": "string", "description": "ID of the user who created the secret.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the secret.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -120512,47 +120394,47 @@ "$id": { "type": "string", "description": "Secret ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Secret creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Secret update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "Application ID this secret belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "secret": { "type": "string", "description": "Application client secret. Returned only when the secret is created; subsequent reads always return an empty value.", - "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, "hint": { "type": "string", "description": "Last few characters of the client secret, used to help identify it.", - "x-example": "f5c6c7" + "example": "f5c6c7" }, "createdById": { "type": "string", "description": "ID of the user who created the secret.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the secret.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -120585,27 +120467,27 @@ "value": { "type": "string", "description": "Scope value as requested by apps.", - "x-example": "organization:organization.read" + "example": "organization:organization.read" }, "description": { "type": "string", "description": "Human-readable description of what the scope grants.", - "x-example": "Access to read the organization" + "example": "Access to read the organization" }, "type": { "type": "string", "description": "What the scope grants access to. One of `account`, `project`, or `organization`. Only `project` and `organization` scopes are installable.", - "x-example": "organization" + "example": "organization" }, "category": { "type": "string", "description": "Scope category, used to group scopes on consent and installation screens.", - "x-example": "Organization" + "example": "Organization" }, "deprecated": { "type": "boolean", "description": "Whether the scope is deprecated. Deprecated scopes can still be requested but should not be offered for new grants.", - "x-example": false + "example": false } }, "required": [ @@ -120630,27 +120512,27 @@ "$id": { "type": "string", "description": "Installation ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Installation creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Installation update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "ID of the installed application.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "teamId": { "type": "string", "description": "ID of the team the application is installed on.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "scopes": { "type": "array", @@ -120658,15 +120540,17 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "organization:organization.read" ] }, "authorizationDetails": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "Authorization details granted to the application. Rich authorization request (RFC 9396) style entries; the Appwrite Console stores authorized project IDs here.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "type": "project", "identifiers": [ @@ -120678,17 +120562,17 @@ "createdById": { "type": "string", "description": "ID of the user who created the installation.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the installation.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time an access token was last issued for the installation in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -120732,47 +120616,47 @@ "$id": { "type": "string", "description": "App key ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "App key creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "App key update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "Application ID this app key belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "secret": { "type": "string", "description": "App key secret.", - "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, "hint": { "type": "string", "description": "Last few characters of the app key secret, used to help identify it.", - "x-example": "f5c6c7" + "example": "f5c6c7" }, "createdById": { "type": "string", "description": "ID of the user who created the app key.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the app key.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time the app key was last used for authentication in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -120805,12 +120689,12 @@ "grantId": { "type": "string", "description": "OAuth2 grant ID. Set when the user must give explicit consent; pass it to the approve or reject endpoint. Empty when a redirect URL is returned instead.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "redirectUrl": { "type": "string", "description": "URL the end user should be redirected to when the flow can complete without consent. Empty when consent is still required.", - "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + "example": "https:\/\/example.com\/callback?code=abcde&state=fghij" } }, "required": [ @@ -120829,7 +120713,7 @@ "redirectUrl": { "type": "string", "description": "URL the end user should be redirected to after the grant is approved, carrying the authorization `code` and\/or `id_token` along with the original `state`.", - "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + "example": "https:\/\/example.com\/callback?code=abcde&state=fghij" } }, "required": [ @@ -120846,7 +120730,7 @@ "redirectUrl": { "type": "string", "description": "URL the end user should be redirected to after the grant is rejected, carrying an `access_denied` error.", - "x-example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + "example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" } }, "required": [ @@ -120863,27 +120747,27 @@ "$id": { "type": "string", "description": "Grant ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Grant creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Grant update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "ID of the user the grant belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "appId": { "type": "string", "description": "ID of the OAuth2 client (app) the grant was requested for.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "scopes": { "type": "array", @@ -120891,7 +120775,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "openid", "email", "profile" @@ -120903,35 +120787,35 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/api.example.com\/" ] }, "authorizationDetails": { "type": "string", "description": "Requested authorization_details the user is being asked to consent to, as a JSON string. Each entry has a `type` plus project-defined fields.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, "prompt": { "type": "string", "description": "OIDC prompt directive the consent screen should honor. Space-separated list of: login, consent, select_account.", - "x-example": "login" + "example": "login" }, "redirectUri": { "type": "string", "description": "Redirect URI the user will be sent to after the flow completes.", - "x-example": "https:\/\/example.com\/callback" + "example": "https:\/\/example.com\/callback" }, "authTime": { "type": "integer", "description": "Unix timestamp of when the user last authenticated.", - "x-example": 1592981250, - "format": "int32" + "format": "int32", + "example": 1592981250 }, "expire": { "type": "string", "description": "Grant expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -120976,34 +120860,34 @@ "device_code": { "type": "string", "description": "Device verification code used by the client to poll the token endpoint.", - "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, "user_code": { "type": "string", "description": "Short code the end user enters on the verification page.", - "x-example": "ABCD-EFGH" + "example": "ABCD-EFGH" }, "verification_uri": { "type": "string", "description": "URL where the end user enters the user code.", - "x-example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device" + "example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device" }, "verification_uri_complete": { "type": "string", "description": "Verification URL with the user code prefilled as a query parameter.", - "x-example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device?user_code=ABCD-EFGH" + "example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device?user_code=ABCD-EFGH" }, "expires_in": { "type": "integer", "description": "Lifetime of the device code and user code in seconds.", - "x-example": 900, - "format": "int32" + "format": "int32", + "example": 900 }, "interval": { "type": "integer", "description": "Minimum polling interval for the token endpoint in seconds.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 } }, "required": [ @@ -121030,13 +120914,13 @@ "request_uri": { "type": "string", "description": "Authorization request handle to pass to the authorize endpoint.", - "x-example": "urn:appwrite:oauth2:request:5e5ea5c16897e" + "example": "urn:appwrite:oauth2:request:5e5ea5c16897e" }, "expires_in": { "type": "integer", "description": "Lifetime of the authorization request handle in seconds.", - "x-example": 600, - "format": "int32" + "format": "int32", + "example": 600 } }, "required": [ @@ -121055,39 +120939,39 @@ "access_token": { "type": "string", "description": "OAuth2 access token.", - "x-example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..." + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..." }, "token_type": { "type": "string", "description": "OAuth2 token type.", - "x-example": "Bearer" + "example": "Bearer" }, "expires_in": { "type": "integer", "description": "Access token lifetime in seconds.", - "x-example": 3600, - "format": "int32" + "format": "int32", + "example": 3600 }, "refresh_token": { "type": "string", "description": "OAuth2 refresh token.", - "x-example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." }, "scope": { "type": "string", "description": "Space-separated scopes granted to the access token.", - "x-example": "openid email profile" + "example": "openid email profile" }, "authorization_details": { "type": "string", "description": "Granted RFC 9396 authorization details as a JSON string.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\"]}]", + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\"]}]", "nullable": true }, "id_token": { "type": "string", "description": "OpenID Connect ID token. Returned when the `openid` scope is granted.", - "x-example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", "nullable": true } }, @@ -121115,32 +120999,32 @@ "$id": { "type": "string", "description": "Consent ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Consent creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Consent update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "ID of the user the consent belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "appId": { "type": "string", "description": "ID of the registered app the consent was given to. Empty for URL-form (CIMD) clients.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "cimdUrl": { "type": "string", "description": "Client ID metadata document URL of the client the consent was given to. Empty for registered apps.", - "x-example": "https:\/\/example.com\/.well-known\/client-metadata.json" + "example": "https:\/\/example.com\/.well-known\/client-metadata.json" }, "scopes": { "type": "array", @@ -121148,7 +121032,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "openid", "email", "profile" @@ -121160,19 +121044,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/api.example.com\/" ] }, "authorizationDetails": { "type": "string", "description": "Authorization details the user consented to, as a JSON string. Each entry has a `type` plus project-defined fields.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, "expire": { "type": "string", "description": "Consent expiration time in ISO 8601 format. Empty when the consent has no token-bound expiry yet.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -121213,37 +121097,37 @@ "$id": { "type": "string", "description": "Token family ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Token update date in ISO 8601 format. Refreshing the token family updates this.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "consentId": { "type": "string", "description": "ID of the consent the token family was issued under.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userId": { "type": "string", "description": "ID of the user the token family belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "appId": { "type": "string", "description": "ID of the registered app the token family was issued to. Empty for URL-form (CIMD) clients.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "cimdUrl": { "type": "string", "description": "Client ID metadata document URL of the client the token family was issued to. Empty for registered apps.", - "x-example": "https:\/\/example.com\/.well-known\/client-metadata.json" + "example": "https:\/\/example.com\/.well-known\/client-metadata.json" }, "scopes": { "type": "array", @@ -121251,7 +121135,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "openid", "email", "profile" @@ -121263,19 +121147,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/api.example.com\/" ] }, "authorizationDetails": { "type": "string", "description": "Authorization details granted on the token family, as a JSON string. Each entry has a `type` plus project-defined fields.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, "expire": { "type": "string", "description": "Expiration time of the current access token of this family in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -121318,52 +121202,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -121376,19 +121260,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -121402,7 +121288,7 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} } }, "required": [ @@ -121453,52 +121339,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -121511,19 +121397,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -121537,7 +121425,7 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} } }, "required": [ @@ -121588,52 +121476,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -121646,19 +121534,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -121672,7 +121562,7 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} } }, "required": [ @@ -121723,52 +121613,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -121781,19 +121671,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -121807,24 +121699,24 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} }, "challengeType": { "type": "string", "description": "Challenge type enforced when the rule matches.", - "x-example": "compute" + "example": "compute" }, "difficulty": { "type": "integer", "description": "Challenge difficulty from 1 (easiest) to 5 (hardest) enforced when the rule matches.", - "x-example": 3, - "format": "int32" + "format": "int32", + "example": 3 }, "ttl": { "type": "integer", "description": "Seconds a visitor stays cleared after passing the challenge before being challenged again.", - "x-example": 1800, - "format": "int32" + "format": "int32", + "example": 1800 } }, "required": [ @@ -121881,52 +121773,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -121939,19 +121831,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -121965,35 +121859,35 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} }, "limit": { "type": "integer", "description": "Maximum number of matching requests allowed for the given interval.", - "x-example": 1000, - "format": "int32" + "format": "int32", + "example": 1000 }, "interval": { "type": "integer", "description": "Interval in seconds for the rate limit window.", - "x-example": 60, - "format": "int32" + "format": "int32", + "example": 60 }, "key": { "type": "string", "description": "Rate limit key: `ip` limits per client IP, `userId` limits per authenticated user.", - "x-example": "userId" + "example": "userId" }, "strategy": { "type": "string", "description": "Rate limit strategy: `fixedWindow`, `slidingWindow`, or `tokenBucket`.", - "x-example": "slidingWindow" + "example": "slidingWindow" }, "maxBucketSize": { "type": "integer", "description": "Maximum burst capacity in tokens, applied by the `tokenBucket` strategy. The sustained refill rate is `limit \/ interval`. Defaults to `limit`.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 } }, "required": [ @@ -122054,52 +121948,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -122112,19 +122006,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -122138,18 +122034,18 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} }, "location": { "type": "string", "description": "Target location for the redirect.", - "x-example": "\/maintenance" + "example": "\/maintenance" }, "statusCode": { "type": "integer", "description": "HTTP status code used for the redirect.", - "x-example": 301, - "format": "int32" + "format": "int32", + "example": 301 } }, "required": [ @@ -122204,16 +122100,15 @@ "total": { "type": "integer", "description": "Total number of rules that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "rules": { "type": "array", "description": "List of rules.", "items": { "$ref": "#\/components\/schemas\/wafRule" - }, - "x-example": "" + } } }, "required": [ @@ -122232,17 +122127,17 @@ "$id": { "type": "string", "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "region": { "type": "string", "description": "Region ID the project is deployed in.", - "x-example": "fra" + "example": "fra" }, "endpoint": { "type": "string", "description": "API endpoint of the region the project is deployed in. Empty when the region has no public hostname configured.", - "x-example": "https:\/\/fra.cloud.appwrite.io\/v1" + "example": "https:\/\/fra.cloud.appwrite.io\/v1" } }, "required": [ @@ -122263,7 +122158,7 @@ "$id": { "type": "string", "description": "Organization ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" } }, "required": [ @@ -122280,16 +122175,15 @@ "total": { "type": "integer", "description": "Total number of projects that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "projects": { "type": "array", "description": "List of projects.", "items": { "$ref": "#\/components\/schemas\/oauth2Project" - }, - "x-example": "" + } } }, "required": [ @@ -122308,16 +122202,15 @@ "total": { "type": "integer", "description": "Total number of organizations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "organizations": { "type": "array", "description": "List of organizations.", "items": { "$ref": "#\/components\/schemas\/oauth2Organization" - }, - "x-example": "" + } } }, "required": [ @@ -122336,16 +122229,15 @@ "total": { "type": "integer", "description": "Total number of consents that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "consents": { "type": "array", "description": "List of consents.", "items": { "$ref": "#\/components\/schemas\/oauth2Consent" - }, - "x-example": "" + } } }, "required": [ @@ -122364,16 +122256,15 @@ "total": { "type": "integer", "description": "Total number of tokens that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "tokens": { "type": "array", "description": "List of tokens.", "items": { "$ref": "#\/components\/schemas\/oauth2ConsentToken" - }, - "x-example": "" + } } }, "required": [ @@ -122392,16 +122283,15 @@ "total": { "type": "integer", "description": "Total number of events that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "events": { "type": "array", "description": "List of events.", "items": { "$ref": "#\/components\/schemas\/activityEvent" - }, - "x-example": "" + } } }, "required": [ @@ -122420,16 +122310,15 @@ "total": { "type": "integer", "description": "Total number of addons that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "addons": { "type": "array", "description": "List of addons.", "items": { "$ref": "#\/components\/schemas\/addon" - }, - "x-example": "" + } } }, "required": [ @@ -122448,16 +122337,15 @@ "total": { "type": "integer", "description": "Total number of aggregations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "aggregations": { "type": "array", "description": "List of aggregations.", "items": { "$ref": "#\/components\/schemas\/aggregationTeam" - }, - "x-example": "" + } } }, "required": [ @@ -122476,16 +122364,15 @@ "total": { "type": "integer", "description": "Total number of archives that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "archives": { "type": "array", "description": "List of archives.", "items": { "$ref": "#\/components\/schemas\/backupArchive" - }, - "x-example": "" + } } }, "required": [ @@ -122504,16 +122391,15 @@ "total": { "type": "integer", "description": "Total number of policies that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "policies": { "type": "array", "description": "List of policies.", "items": { "$ref": "#\/components\/schemas\/backupPolicy" - }, - "x-example": "" + } } }, "required": [ @@ -122532,16 +122418,15 @@ "total": { "type": "integer", "description": "Total number of restorations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "restorations": { "type": "array", "description": "List of restorations.", "items": { "$ref": "#\/components\/schemas\/backupRestoration" - }, - "x-example": "" + } } }, "required": [ @@ -122560,16 +122445,15 @@ "total": { "type": "integer", "description": "Total number of billingAddresses that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "billingAddresses": { "type": "array", "description": "List of billingAddresses.", "items": { "$ref": "#\/components\/schemas\/billingAddress" - }, - "x-example": "" + } } }, "required": [ @@ -122588,16 +122472,15 @@ "total": { "type": "integer", "description": "Total number of invoices that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "invoices": { "type": "array", "description": "List of invoices.", "items": { "$ref": "#\/components\/schemas\/invoice" - }, - "x-example": "" + } } }, "required": [ @@ -122616,16 +122499,15 @@ "total": { "type": "integer", "description": "Total number of plans that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "plans": { "type": "array", "description": "List of plans.", "items": { "$ref": "#\/components\/schemas\/billingPlan" - }, - "x-example": "" + } } }, "required": [ @@ -122644,16 +122526,15 @@ "total": { "type": "integer", "description": "Total number of blocks that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "blocks": { "type": "array", "description": "List of blocks.", "items": { "$ref": "#\/components\/schemas\/block" - }, - "x-example": "" + } } }, "required": [ @@ -122672,16 +122553,15 @@ "total": { "type": "integer", "description": "Total number of migrations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "migrations": { "type": "array", "description": "List of migrations.", "items": { "$ref": "#\/components\/schemas\/databaseMigration" - }, - "x-example": "" + } } }, "required": [ @@ -122700,16 +122580,15 @@ "total": { "type": "integer", "description": "Total number of databases that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "databases": { "type": "array", "description": "List of databases.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabase" - }, - "x-example": "" + } } }, "required": [ @@ -122728,16 +122607,15 @@ "total": { "type": "integer", "description": "Total number of dnsRecords that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "dnsRecords": { "type": "array", "description": "List of dnsRecords.", "items": { "$ref": "#\/components\/schemas\/dnsRecord" - }, - "x-example": "" + } } }, "required": [ @@ -122756,16 +122634,15 @@ "total": { "type": "integer", "description": "Total number of suggestions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "suggestions": { "type": "array", "description": "List of suggestions.", "items": { "$ref": "#\/components\/schemas\/domainSuggestion" - }, - "x-example": "" + } } }, "required": [ @@ -122784,16 +122661,15 @@ "total": { "type": "integer", "description": "Total number of domains that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "domains": { "type": "array", "description": "List of domains.", "items": { "$ref": "#\/components\/schemas\/domain" - }, - "x-example": "" + } } }, "required": [ @@ -122812,16 +122688,15 @@ "total": { "type": "integer", "description": "Total number of teams that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "teams": { "type": "array", "description": "List of teams.", "items": { "$ref": "#\/components\/schemas\/organization" - }, - "x-example": "" + } } }, "required": [ @@ -122840,16 +122715,15 @@ "total": { "type": "integer", "description": "Total number of paymentMethods that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "paymentMethods": { "type": "array", "description": "List of paymentMethods.", "items": { "$ref": "#\/components\/schemas\/paymentMethod" - }, - "x-example": "" + } } }, "required": [ @@ -122868,16 +122742,15 @@ "total": { "type": "integer", "description": "Total number of extensions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "extensions": { "type": "array", "description": "List of extensions.", "items": { "$ref": "#\/components\/schemas\/postgresExtension" - }, - "x-example": "" + } } }, "required": [ @@ -122896,16 +122769,15 @@ "total": { "type": "integer", "description": "Total number of regions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "regions": { "type": "array", "description": "List of regions.", "items": { "$ref": "#\/components\/schemas\/consoleRegion" - }, - "x-example": "" + } } }, "required": [ @@ -122924,16 +122796,15 @@ "total": { "type": "integer", "description": "Total number of apps that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "apps": { "type": "array", "description": "List of apps.", "items": { "$ref": "#\/components\/schemas\/app" - }, - "x-example": "" + } } }, "required": [ @@ -122952,16 +122823,15 @@ "total": { "type": "integer", "description": "Total number of secrets that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "secrets": { "type": "array", "description": "List of secrets.", "items": { "$ref": "#\/components\/schemas\/appSecret" - }, - "x-example": "" + } } }, "required": [ @@ -122980,16 +122850,15 @@ "total": { "type": "integer", "description": "Total number of scopes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "scopes": { "type": "array", "description": "List of scopes.", "items": { "$ref": "#\/components\/schemas\/appScope" - }, - "x-example": "" + } } }, "required": [ @@ -123008,16 +122877,15 @@ "total": { "type": "integer", "description": "Total number of installations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "installations": { "type": "array", "description": "List of installations.", "items": { "$ref": "#\/components\/schemas\/appInstallation" - }, - "x-example": "" + } } }, "required": [ @@ -123036,16 +122904,15 @@ "total": { "type": "integer", "description": "Total number of keys that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "keys": { "type": "array", "description": "List of keys.", "items": { "$ref": "#\/components\/schemas\/appKey" - }, - "x-example": "" + } } }, "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 6f49c883b..ab7b8bcb5 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 @@ -141,7 +141,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -149,20 +149,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -245,7 +245,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -309,7 +309,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<CONSENT_ID>" + "example": "<CONSENT_ID>" }, "in": "path" } @@ -366,7 +366,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<CONSENT_ID>" + "example": "<CONSENT_ID>" }, "in": "path" } @@ -429,7 +429,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<CONSENT_ID>" + "example": "<CONSENT_ID>" }, "in": "path" }, @@ -452,7 +452,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -516,7 +516,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<CONSENT_ID>" + "example": "<CONSENT_ID>" }, "in": "path" }, @@ -526,7 +526,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOKEN_ID>" + "example": "<TOKEN_ID>" }, "in": "path" } @@ -583,7 +583,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<CONSENT_ID>" + "example": "<CONSENT_ID>" }, "in": "path" }, @@ -593,7 +593,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOKEN_ID>" + "example": "<TOKEN_ID>" }, "in": "path" } @@ -659,13 +659,13 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -749,7 +749,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -807,7 +807,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<IDENTITY_ID>" + "example": "<IDENTITY_ID>" }, "in": "path" } @@ -884,7 +884,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -951,7 +951,7 @@ "mfa": { "type": "boolean", "description": "Enable or disable MFA.", - "x-example": false + "example": false } }, "required": [ @@ -1078,7 +1078,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -1209,7 +1209,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -1230,7 +1230,7 @@ "otp": { "type": "string", "description": "Valid verification token.", - "x-example": "<OTP>" + "example": "<OTP>" } }, "required": [ @@ -1346,7 +1346,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -1477,7 +1477,7 @@ "factor": { "type": "string", "description": "Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`, `custom`.", - "x-example": "email", + "example": "email", "enum": [ "email", "phone", @@ -1623,12 +1623,12 @@ "challengeId": { "type": "string", "description": "ID of the challenge.", - "x-example": "<CHALLENGE_ID>" + "example": "<CHALLENGE_ID>" }, "otp": { "type": "string", "description": "Valid verification token.", - "x-example": "<OTP>" + "example": "<OTP>" } }, "required": [ @@ -2104,7 +2104,7 @@ "name": { "type": "string", "description": "User name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -2175,14 +2175,14 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" }, "oldPassword": { "type": "string", "description": "Current user password. Max length: 256 chars.", "default": "", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -2254,13 +2254,13 @@ "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "password": { "type": "string", "description": "User password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -2384,7 +2384,11 @@ "type": "object", "description": "Prefs key-value JSON object.", "default": {}, - "x-example": "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}" + "example": { + "language": "en", + "timezone": "UTC", + "darkTheme": true + } } }, "required": [ @@ -2458,13 +2462,13 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "url": { "type": "string", "description": "URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" } }, @@ -2535,17 +2539,17 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "secret": { "type": "string", "description": "Valid reset token.", - "x-example": "<SECRET>" + "example": "<SECRET>" }, "password": { "type": "string", "description": "New user password. Must be between 8 and 256 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -2766,13 +2770,13 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -2849,7 +2853,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -2857,7 +2861,7 @@ "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "<SECRET>" + "example": "<SECRET>" } }, "required": [ @@ -2933,7 +2937,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -2941,7 +2945,7 @@ "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "<SECRET>" + "example": "<SECRET>" } }, "required": [ @@ -3013,7 +3017,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -3021,7 +3025,7 @@ "secret": { "type": "string", "description": "Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.", - "x-example": "<SECRET>" + "example": "<SECRET>" } }, "required": [ @@ -3091,7 +3095,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SESSION_ID>", + "example": "<SESSION_ID>", "default": "current" }, "in": "path" @@ -3154,7 +3158,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SESSION_ID>", + "example": "<SESSION_ID>", "default": "current" }, "in": "path" @@ -3210,7 +3214,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SESSION_ID>", + "example": "<SESSION_ID>", "default": "current" }, "in": "path" @@ -3332,7 +3336,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -3340,14 +3344,14 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "phrase": { "type": "boolean", "description": "Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -3422,7 +3426,7 @@ "userId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -3430,21 +3434,21 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "url": { "type": "string", "description": "URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "phrase": { "type": "boolean", "description": "Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -3515,7 +3519,7 @@ "required": true, "schema": { "type": "string", - "x-example": "amazon", + "example": "amazon", "enum": [ "amazon", "apple", @@ -3619,7 +3623,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -3631,7 +3635,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -3714,7 +3718,7 @@ "userId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -3722,7 +3726,7 @@ "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" } }, @@ -3849,7 +3853,7 @@ "url": { "type": "string", "description": "URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" } }, @@ -3977,12 +3981,12 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "<SECRET>" + "example": "<SECRET>" } }, "required": [ @@ -4107,12 +4111,12 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "secret": { "type": "string", "description": "Valid verification token.", - "x-example": "<SECRET>" + "example": "<SECRET>" } }, "required": [ @@ -4245,7 +4249,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<EVENT_ID>" + "example": "<EVENT_ID>" }, "in": "path" } @@ -4322,7 +4326,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -4387,7 +4391,7 @@ "appId": { "type": "string", "description": "Application ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<APP_ID>", + "example": "<APP_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -4395,47 +4399,46 @@ "name": { "type": "string", "description": "Application name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Application description shown to users during OAuth2 consent.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "clientUri": { "type": "string", "description": "Application homepage URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "logoUri": { "type": "string", "description": "Application logo URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "privacyPolicyUrl": { "type": "string", "description": "Application privacy policy URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "termsUrl": { "type": "string", "description": "Application terms of service URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "contacts": { "type": "array", "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4444,13 +4447,12 @@ "type": "string", "description": "Application tagline shown to users during OAuth2 consent.", "default": "", - "x-example": "<TAGLINE>" + "example": "<TAGLINE>" }, "tags": { "type": "array", "description": "Application tags shown to users during OAuth2 consent. Maximum of 100 tags are allowed, each up to 64 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4459,7 +4461,6 @@ "type": "array", "description": "Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4468,20 +4469,19 @@ "type": "string", "description": "Application support URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "dataDeletionUrl": { "type": "string", "description": "Application data deletion URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "redirectUris": { "type": "array", "description": "Redirect URIs. Each must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI (e.g. com.example.app:\/oauth), and must not contain a fragment.", - "x-example": null, "items": { "type": "string" } @@ -4490,7 +4490,6 @@ "type": "array", "description": "Post-logout redirect URIs for OpenID Connect RP-Initiated Logout. Each must be an https URL, an http loopback URL, or a private-use scheme URI, and must not contain a fragment. After ending the user session, the logout endpoint only redirects to URIs in this list.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4499,25 +4498,25 @@ "type": "boolean", "description": "Is application enabled?", "default": true, - "x-example": false + "example": false }, "type": { "type": "string", "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", "default": "confidential", - "x-example": "public" + "example": "public" }, "deviceFlow": { "type": "boolean", "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", "default": false, - "x-example": false + "example": false }, "teamId": { "type": "string", "description": "Team unique ID.", "default": "", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" } }, "required": [ @@ -4692,7 +4691,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" } @@ -4754,7 +4753,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" } @@ -4768,47 +4767,46 @@ "name": { "type": "string", "description": "Application name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Application description shown to users during OAuth2 consent.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "clientUri": { "type": "string", "description": "Application homepage URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "logoUri": { "type": "string", "description": "Application logo URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "privacyPolicyUrl": { "type": "string", "description": "Application privacy policy URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "termsUrl": { "type": "string", "description": "Application terms of service URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "contacts": { "type": "array", "description": "Application support or security contact emails. Maximum of 100 contacts are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4817,13 +4815,12 @@ "type": "string", "description": "Application tagline shown to users during OAuth2 consent.", "default": "", - "x-example": "<TAGLINE>" + "example": "<TAGLINE>" }, "tags": { "type": "array", "description": "Application tags shown to users during OAuth2 consent. Maximum of 100 tags are allowed, each up to 64 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4832,7 +4829,6 @@ "type": "array", "description": "Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4841,27 +4837,26 @@ "type": "string", "description": "Application support URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "dataDeletionUrl": { "type": "string", "description": "Application data deletion URL shown to users during OAuth2 consent.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "enabled": { "type": "boolean", "description": "Is application enabled?", "default": true, - "x-example": false + "example": false }, "redirectUris": { "type": "array", "description": "Redirect URIs. Each must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI (e.g. com.example.app:\/oauth), and must not contain a fragment.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4870,7 +4865,6 @@ "type": "array", "description": "Post-logout redirect URIs for OpenID Connect RP-Initiated Logout. Each must be an https URL, an http loopback URL, or a private-use scheme URI, and must not contain a fragment. After ending the user session, the logout endpoint only redirects to URIs in this list.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4879,19 +4873,18 @@ "type": "string", "description": "OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` \u2014 PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.", "default": "confidential", - "x-example": "public" + "example": "public" }, "deviceFlow": { "type": "boolean", "description": "Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.", "default": false, - "x-example": false + "example": false }, "installationScopes": { "type": "array", "description": "Scopes the application requests when installed on a team. Only scopes allowed by the project's OAuth2 server installation scopes configuration are accepted; use the list installation scopes endpoint to discover available values. Maximum of 100 scopes are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -4900,7 +4893,7 @@ "type": "string", "description": "URL users are redirected to after creating or updating an installation of this application. Must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI, and must not contain a fragment. Leave empty for no redirect.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" } }, @@ -4964,7 +4957,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" } @@ -5031,7 +5024,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" }, @@ -5054,7 +5047,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -5122,7 +5115,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" }, @@ -5132,7 +5125,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -5190,7 +5183,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" }, @@ -5200,7 +5193,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -5267,7 +5260,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" }, @@ -5277,7 +5270,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -5341,7 +5334,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" }, @@ -5364,7 +5357,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -5427,7 +5420,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" } @@ -5491,7 +5484,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" }, @@ -5501,7 +5494,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -5559,7 +5552,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" }, @@ -5569,7 +5562,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -5630,7 +5623,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" } @@ -5644,7 +5637,6 @@ "labels": { "type": "array", "description": "Array of application labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", - "x-example": null, "items": { "type": "string" } @@ -5716,7 +5708,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" }, @@ -5739,7 +5731,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -5802,7 +5794,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" } @@ -5866,7 +5858,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" }, @@ -5876,7 +5868,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SECRET_ID>" + "example": "<SECRET_ID>" }, "in": "path" } @@ -5934,7 +5926,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" }, @@ -5944,7 +5936,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SECRET_ID>" + "example": "<SECRET_ID>" }, "in": "path" } @@ -6008,7 +6000,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" } @@ -6022,7 +6014,7 @@ "teamId": { "type": "string", "description": "Team ID of the team to transfer application to.", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" } }, "required": [ @@ -6087,7 +6079,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "in": "path" } @@ -6155,7 +6147,7 @@ "required": true, "schema": { "type": "string", - "x-example": "aa", + "example": "aa", "enum": [ "aa", "an", @@ -6199,7 +6191,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -6211,7 +6203,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -6223,7 +6215,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -6292,7 +6284,7 @@ "required": true, "schema": { "type": "string", - "x-example": "amex", + "example": "amex", "enum": [ "amex", "argencard", @@ -6342,7 +6334,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -6354,7 +6346,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -6366,7 +6358,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -6436,7 +6428,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" } @@ -6504,7 +6496,7 @@ "required": true, "schema": { "type": "string", - "x-example": "af", + "example": "af", "enum": [ "af", "ao", @@ -6910,7 +6902,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -6922,7 +6914,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 100 }, "in": "query" @@ -6934,7 +6926,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -7004,7 +6996,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" }, @@ -7015,7 +7007,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 400 }, "in": "query" @@ -7027,7 +7019,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 400 }, "in": "query" @@ -7096,7 +7088,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<NAME>", + "example": "<NAME>", "default": "" }, "in": "query" @@ -7108,7 +7100,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 500 }, "in": "query" @@ -7120,7 +7112,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 500 }, "in": "query" @@ -7199,7 +7191,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEXT>" + "example": "<TEXT>" }, "in": "query" }, @@ -7210,7 +7202,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 400 }, "in": "query" @@ -7222,7 +7214,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 1 }, "in": "query" @@ -7233,7 +7225,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": false }, "in": "query" @@ -7303,7 +7295,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "in": "query" }, @@ -7314,7 +7306,10 @@ "schema": { "type": "object", "default": [], - "x-example": "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}" + "example": { + "Authorization": "Bearer token123", + "X-Custom-Header": "value" + } }, "in": "query" }, @@ -7325,7 +7320,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "1920", + "example": 1920, "default": 1280 }, "in": "query" @@ -7337,7 +7332,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "1080", + "example": 1080, "default": 720 }, "in": "query" @@ -7349,7 +7344,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "2", + "example": 2, "default": 1 }, "in": "query" @@ -7360,7 +7355,7 @@ "required": false, "schema": { "type": "string", - "x-example": "dark", + "example": "dark", "enum": [ "light", "dark" @@ -7380,7 +7375,7 @@ "required": false, "schema": { "type": "string", - "x-example": "Mozilla\/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit\/605.1.15", + "example": "Mozilla\/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit\/605.1.15", "default": "" }, "in": "query" @@ -7391,7 +7386,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": "true", + "example": true, "default": false }, "in": "query" @@ -7402,7 +7397,7 @@ "required": false, "schema": { "type": "string", - "x-example": "en-US", + "example": "en-US", "default": "" }, "in": "query" @@ -7413,7 +7408,7 @@ "required": false, "schema": { "type": "string", - "x-example": "America\/New_York", + "example": "America\/New_York", "enum": [ "africa\/abidjan", "africa\/accra", @@ -8267,7 +8262,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "37.7749", + "example": 37.7749, "default": 0 }, "in": "query" @@ -8279,7 +8274,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "-122.4194", + "example": -122.4194, "default": 0 }, "in": "query" @@ -8291,7 +8286,7 @@ "schema": { "type": "number", "format": "float", - "x-example": "100", + "example": 100, "default": 0 }, "in": "query" @@ -8302,7 +8297,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": "true", + "example": true, "default": false }, "in": "query" @@ -8361,7 +8356,10 @@ "xr-spatial-tracking" ] }, - "x-example": "[\"geolocation\",\"notifications\"]", + "example": [ + "geolocation", + "notifications" + ], "default": [] }, "in": "query" @@ -8373,7 +8371,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "3", + "example": 3, "default": 0 }, "in": "query" @@ -8385,7 +8383,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "800", + "example": 800, "default": 0 }, "in": "query" @@ -8397,7 +8395,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "600", + "example": 600, "default": 0 }, "in": "query" @@ -8409,7 +8407,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": "85", + "example": 85, "default": -1 }, "in": "query" @@ -8420,7 +8418,7 @@ "required": false, "schema": { "type": "string", - "x-example": "jpeg", + "example": "jpeg", "enum": [ "jpg", "jpeg", @@ -8566,7 +8564,6 @@ "services": { "type": "array", "description": "Array of services to backup", - "x-example": null, "items": { "type": "string", "enum": [ @@ -8593,8 +8590,8 @@ "resourceId": { "type": "string", "description": "Resource ID. When set, only this single resource will be backed up.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true } }, "required": [ @@ -8661,7 +8658,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ARCHIVE_ID>" + "example": "<ARCHIVE_ID>" }, "in": "path" } @@ -8720,7 +8717,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "<ARCHIVE_ID>" + "example": "<ARCHIVE_ID>" }, "in": "path" } @@ -8853,7 +8850,7 @@ "policyId": { "type": "string", "description": "Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<POLICY_ID>", + "example": "<POLICY_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -8862,12 +8859,11 @@ "type": "string", "description": "Policy name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "services": { "type": "array", "description": "Array of services to backup", - "x-example": null, "items": { "type": "string", "enum": [ @@ -8894,25 +8890,24 @@ "resourceId": { "type": "string", "description": "Resource ID. When set, only this single resource will be backed up.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "enabled": { "type": "boolean", "description": "Is policy enabled? When set to 'disabled', no backups will be taken", "default": true, - "x-example": false + "example": false }, "retention": { "type": "integer", "description": "Days to keep backups before deletion", - "x-example": 1, + "example": 1, "format": "int32" }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." } }, "required": [ @@ -8985,7 +8980,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -9048,7 +9043,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -9062,26 +9057,25 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "retention": { "type": "integer", "description": "Days to keep backups before deletion", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "schedule": { "type": "string", - "description": "Cron expression", - "x-example": null + "description": "Cron expression" }, "enabled": { "type": "boolean", "description": "Is Backup enabled? When set to 'disabled', No backup will be taken", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -9145,7 +9139,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -9209,12 +9203,11 @@ "archiveId": { "type": "string", "description": "Backup archive ID to restore", - "x-example": "<ARCHIVE_ID>" + "example": "<ARCHIVE_ID>" }, "services": { "type": "array", "description": "Array of services to restore", - "x-example": null, "items": { "type": "string", "enum": [ @@ -9242,7 +9235,7 @@ "type": "string", "description": "Destination resource ID. Omit to restore the archived resource in place, or pass a different ID to restore alongside it as a new resource. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": "", - "x-example": "<NEW_RESOURCE_ID>", + "example": "<NEW_RESOURCE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -9251,7 +9244,7 @@ "type": "string", "description": "Database name. Max length: 128 chars.", "default": "", - "x-example": "<NEW_RESOURCE_NAME>" + "example": "<NEW_RESOURCE_NAME>" } }, "required": [ @@ -9384,7 +9377,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RESTORATION_ID>" + "example": "<RESTORATION_ID>" }, "in": "path" } @@ -9493,7 +9486,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -9504,7 +9497,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -9604,7 +9597,7 @@ "databaseId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -9612,13 +9605,13 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -9766,7 +9759,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -9838,7 +9831,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -9905,7 +9898,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -9920,13 +9913,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -9988,7 +9981,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -10057,7 +10050,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -10072,7 +10065,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "<DATABASE_ID>", + "collectionId": "<COLLECTION_ID>", + "documentId": "<DOCUMENT_ID>", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -10173,7 +10176,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -10269,7 +10272,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -10283,13 +10286,13 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false } } } @@ -10377,7 +10380,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -10443,7 +10446,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -10466,7 +10469,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -10477,7 +10480,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -10542,7 +10545,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -10556,7 +10559,7 @@ "collectionId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<COLLECTION_ID>", + "example": "<COLLECTION_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -10564,34 +10567,35 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "documentSecurity": { "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "attributes": { "type": "array", "description": "Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, varchar, text, mediumtext, longtext, integer, bigint, double, boolean, datetime, point, linestring, polygon, email, url, ip, enum), size (integer, required for string and varchar types), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -10600,7 +10604,6 @@ "type": "array", "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", "default": [], - "x-example": null, "items": { "type": "object" } @@ -10675,7 +10678,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -10685,7 +10688,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -10749,7 +10752,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -10759,7 +10762,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -10773,34 +10776,36 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "documentSecurity": { "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "purge": { "type": "boolean", "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", "default": false, - "x-example": false + "example": false } } } @@ -10859,7 +10864,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -10869,7 +10874,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -10935,7 +10940,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -10945,7 +10950,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -10968,7 +10973,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -11035,7 +11040,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -11045,7 +11050,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -11058,40 +11063,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -11163,7 +11164,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -11173,7 +11174,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -11196,34 +11197,30 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -11295,7 +11292,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -11305,7 +11302,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -11318,25 +11315,24 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -11408,7 +11404,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -11418,7 +11414,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -11441,19 +11437,18 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "newKey": { "type": "string", "description": "New attribute key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -11525,7 +11520,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -11535,7 +11530,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -11548,26 +11543,25 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -11639,7 +11633,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -11649,7 +11643,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -11672,20 +11666,19 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New attribute key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -11757,7 +11750,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -11767,7 +11760,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -11780,26 +11773,25 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -11871,7 +11863,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -11881,7 +11873,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -11904,20 +11896,19 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -11989,7 +11980,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -11999,7 +11990,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -12012,13 +12003,11 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "elements": { "type": "array", "description": "Array of enum values.", - "x-example": null, "items": { "type": "string" } @@ -12026,19 +12015,19 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -12111,7 +12100,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -12121,7 +12110,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -12144,7 +12133,6 @@ "elements": { "type": "array", "description": "Updated list of enum values.", - "x-example": null, "items": { "type": "string" } @@ -12152,19 +12140,18 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -12237,7 +12224,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -12247,7 +12234,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -12260,40 +12247,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "number", "description": "Minimum value.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "max": { "type": "number", "description": "Maximum value.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "default": { "type": "number", "description": "Default value. Cannot be set when required.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -12365,7 +12348,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -12375,7 +12358,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -12398,34 +12381,30 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "number", "description": "Minimum value.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "max": { "type": "number", "description": "Maximum value.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "default": { "type": "number", "description": "Default value. Cannot be set when required.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -12497,7 +12476,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -12507,7 +12486,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -12520,40 +12499,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -12625,7 +12600,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -12635,7 +12610,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -12658,34 +12633,30 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -12757,7 +12728,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -12767,7 +12738,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -12780,25 +12751,23 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -12870,7 +12839,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -12880,7 +12849,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -12903,19 +12872,17 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value. Cannot be set when attribute is required.", - "x-example": null, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -12987,7 +12954,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -12997,7 +12964,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -13010,18 +12977,30 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "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]]", + "example": [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ] + ], "items": { "type": "array", "items": { @@ -13029,7 +13008,7 @@ "format": "double" } }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -13101,7 +13080,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -13111,7 +13090,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -13134,12 +13113,25 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "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]]", + "example": [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ] + ], "items": { "type": "array", "items": { @@ -13147,13 +13139,12 @@ "format": "double" } }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New attribute key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -13224,7 +13215,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -13234,7 +13225,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -13247,31 +13238,30 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "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 + "example": false } }, "required": [ @@ -13343,7 +13333,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -13353,7 +13343,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -13376,19 +13366,18 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -13460,7 +13449,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -13470,7 +13459,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -13483,31 +13472,30 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "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 + "example": false } }, "required": [ @@ -13579,7 +13567,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -13589,7 +13577,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -13612,19 +13600,18 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -13696,7 +13683,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -13706,7 +13693,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -13719,23 +13706,25 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "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]", + "example": [ + 1, + 2 + ], "items": { "type": "number", "format": "double" }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -13807,7 +13796,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -13817,7 +13806,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -13840,23 +13829,25 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "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]", + "example": [ + 1, + 2 + ], "items": { "type": "number", "format": "double" }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New attribute key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -13927,7 +13918,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -13937,7 +13928,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -13950,18 +13941,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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]]]", + "example": [ + [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ], + [ + 1, + 2 + ] + ] + ], "items": { "type": "array", "items": { @@ -13972,7 +13981,7 @@ } } }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -14044,7 +14053,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -14054,7 +14063,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -14077,12 +14086,31 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "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]]]", + "example": [ + [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ], + [ + 1, + 2 + ] + ] + ], "items": { "type": "array", "items": { @@ -14093,13 +14121,12 @@ } } }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New attribute key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -14170,7 +14197,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -14180,7 +14207,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -14194,12 +14221,12 @@ "relatedCollectionId": { "type": "string", "description": "Related Collection ID.", - "x-example": "<RELATED_COLLECTION_ID>" + "example": "<RELATED_COLLECTION_ID>" }, "type": { "type": "string", "description": "Relationship type. Possible values are: oneToOne, oneToMany, manyToOne, manyToMany.", - "x-example": "oneToOne", + "example": "oneToOne", "enum": [ "oneToOne", "manyToOne", @@ -14218,25 +14245,23 @@ "type": "boolean", "description": "Is Two Way?", "default": false, - "x-example": false + "example": false }, "key": { "type": "string", "description": "Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true }, "twoWayKey": { "type": "string", "description": "Two Way Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true }, "onDelete": { "type": "string", "description": "Delete constraint. Possible values are: cascade, restrict, setNull.", "default": "restrict", - "x-example": "cascade", + "example": "cascade", "enum": [ "cascade", "restrict", @@ -14319,7 +14344,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -14329,7 +14354,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -14352,7 +14377,7 @@ "onDelete": { "type": "string", "description": "Delete constraint. Possible values are: cascade, restrict, setNull.", - "x-example": "cascade", + "example": "cascade", "enum": [ "cascade", "restrict", @@ -14368,8 +14393,7 @@ "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -14437,7 +14461,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -14447,7 +14471,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -14460,37 +14484,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "size": { "type": "integer", "description": "Attribute size for text attributes, in number of characters.", - "x-example": 1, + "example": 1, "format": "int32" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "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 + "example": false } }, "required": [ @@ -14563,7 +14586,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -14573,7 +14596,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -14596,26 +14619,25 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "size": { "type": "integer", "description": "Maximum size of the string attribute.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -14687,7 +14709,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -14697,7 +14719,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -14710,31 +14732,30 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "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 + "example": false } }, "required": [ @@ -14806,7 +14827,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -14816,7 +14837,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -14839,19 +14860,18 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -14923,7 +14943,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -14933,7 +14953,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -14946,26 +14966,25 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -15037,7 +15056,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -15047,7 +15066,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -15070,20 +15089,19 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -15155,7 +15173,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -15165,7 +15183,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -15178,37 +15196,36 @@ "properties": { "key": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Attribute Key." }, "size": { "type": "integer", "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", - "x-example": 1, + "example": 1, "format": "int32" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is attribute an array?", "default": false, - "x-example": false + "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 + "example": false } }, "required": [ @@ -15281,7 +15298,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -15291,7 +15308,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -15314,26 +15331,25 @@ "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "size": { "type": "integer", "description": "Maximum size of the varchar attribute.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -15487,7 +15503,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -15497,7 +15513,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -15563,7 +15579,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -15573,7 +15589,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -15651,7 +15667,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -15661,7 +15677,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -15684,7 +15700,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" }, @@ -15694,7 +15710,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -15706,7 +15722,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -15845,7 +15861,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -15855,7 +15871,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -15869,7 +15885,7 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DOCUMENT_ID>", + "example": "<DOCUMENT_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -15878,22 +15894,29 @@ "type": "object", "description": "Document data as JSON object.", "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "documents": { "type": "array", "description": "Array of documents data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -15901,8 +15924,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } }, "required": [ @@ -16007,7 +16030,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -16017,7 +16040,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -16031,7 +16054,6 @@ "documents": { "type": "array", "description": "Array of document data as JSON objects. May contain partial documents.", - "x-example": null, "items": { "type": "object" } @@ -16039,8 +16061,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } }, "required": [ @@ -16109,7 +16131,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -16119,7 +16141,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -16134,13 +16156,18 @@ "type": "object", "description": "Document data as JSON object. Include only attribute 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}" + "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" } @@ -16148,8 +16175,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -16215,7 +16242,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -16225,7 +16252,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -16248,7 +16275,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -16317,7 +16344,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -16327,7 +16354,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -16337,7 +16364,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -16360,7 +16387,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -16464,7 +16491,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -16474,7 +16501,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -16487,7 +16514,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" } @@ -16502,22 +16529,30 @@ "type": "object", "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -16586,7 +16621,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -16596,7 +16631,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -16606,7 +16641,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" } @@ -16621,22 +16656,30 @@ "type": "object", "description": "Document data as JSON object. Include only attribute 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}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -16698,7 +16741,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -16708,7 +16751,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -16718,7 +16761,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -16728,7 +16771,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -16797,7 +16840,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -16807,7 +16850,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -16817,7 +16860,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -16841,21 +16884,19 @@ "type": "number", "description": "Value to increment the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "min": { "type": "number", "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -16926,7 +16967,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -16936,7 +16977,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -16946,7 +16987,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -16970,21 +17011,19 @@ "type": "number", "description": "Value to increment the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "max": { "type": "number", "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -17052,7 +17091,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -17062,7 +17101,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -17085,7 +17124,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -17150,7 +17189,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -17160,7 +17199,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -17173,13 +17212,12 @@ "properties": { "key": { "type": "string", - "description": "Index Key.", - "x-example": null + "description": "Index Key." }, "type": { "type": "string", "description": "Index type.", - "x-example": "key", + "example": "key", "enum": [ "key", "fulltext", @@ -17197,7 +17235,6 @@ "attributes": { "type": "array", "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "x-example": null, "items": { "type": "string" } @@ -17206,7 +17243,6 @@ "type": "array", "description": "Array of index orders. Maximum of 100 orders are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -17224,7 +17260,6 @@ "type": "array", "description": "Length of index. Maximum of 100", "default": [], - "x-example": null, "items": { "type": "integer" } @@ -17300,7 +17335,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -17310,7 +17345,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -17376,7 +17411,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -17386,7 +17421,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -17470,7 +17505,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -17533,7 +17568,7 @@ "databaseId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -17541,32 +17576,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.", "default": "serverless", - "x-example": "serverless" + "example": "serverless" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } }, "required": [ @@ -17755,7 +17790,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -17823,7 +17858,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -17886,7 +17921,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -17901,13 +17936,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -17965,7 +18000,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -18029,7 +18064,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -18044,7 +18079,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "<DATABASE_ID>", + "collectionId": "<COLLECTION_ID>", + "documentId": "<DOCUMENT_ID>", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -18111,7 +18156,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -18171,7 +18216,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -18185,32 +18230,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.", - "x-example": "serverless", - "x-nullable": true + "example": "serverless", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } }, "required": [ @@ -18268,7 +18313,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -18330,7 +18375,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -18353,7 +18398,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -18364,7 +18409,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -18425,7 +18470,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -18439,7 +18484,7 @@ "collectionId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<COLLECTION_ID>", + "example": "<COLLECTION_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -18447,34 +18492,35 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "documentSecurity": { "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "attributes": { "type": "array", "description": "Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, varchar, text, mediumtext, longtext, integer, bigint, double, boolean, datetime, point, linestring, polygon, email, url, ip, enum), size (integer, required for string and varchar types), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -18483,7 +18529,6 @@ "type": "array", "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", "default": [], - "x-example": null, "items": { "type": "object" } @@ -18554,7 +18599,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -18564,7 +18609,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -18624,7 +18669,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -18634,7 +18679,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -18648,12 +18693,14 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -18662,19 +18709,19 @@ "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "purge": { "type": "boolean", "description": "When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -18732,7 +18779,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -18742,7 +18789,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -18807,7 +18854,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -18817,7 +18864,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -18840,7 +18887,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" }, @@ -18850,7 +18897,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -18862,7 +18909,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -18987,7 +19034,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -18997,7 +19044,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -19011,7 +19058,7 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DOCUMENT_ID>", + "example": "<DOCUMENT_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -19020,12 +19067,20 @@ "type": "object", "description": "Document data as JSON object.", "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -19034,7 +19089,6 @@ "type": "array", "description": "Array of documents data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -19042,7 +19096,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } }, "required": [ @@ -19139,7 +19193,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -19149,7 +19203,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -19163,7 +19217,6 @@ "documents": { "type": "array", "description": "Array of document data as JSON objects. May contain partial documents.", - "x-example": null, "items": { "type": "object" } @@ -19171,7 +19224,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } }, "required": [ @@ -19236,7 +19289,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -19246,7 +19299,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -19261,13 +19314,12 @@ "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", "default": [], - "x-example": "{}" + "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" } @@ -19275,7 +19327,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -19337,7 +19389,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -19347,7 +19399,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -19370,7 +19422,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -19435,7 +19487,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -19445,7 +19497,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -19455,7 +19507,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -19478,7 +19530,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -19574,7 +19626,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -19584,7 +19636,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -19594,7 +19646,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" } @@ -19609,12 +19661,14 @@ "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -19622,7 +19676,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -19687,7 +19741,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -19697,7 +19751,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -19707,7 +19761,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" } @@ -19722,12 +19776,14 @@ "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -19735,7 +19791,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -19793,7 +19849,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -19803,7 +19859,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -19813,7 +19869,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -19823,7 +19879,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -19888,7 +19944,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -19898,7 +19954,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -19908,7 +19964,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -19932,19 +19988,17 @@ "type": "number", "description": "Value to decrement the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "min": { "type": "number", "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, "format": "float" }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -20011,7 +20065,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -20021,7 +20075,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -20031,7 +20085,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -20055,19 +20109,17 @@ "type": "number", "description": "Value to increment the attribute by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "max": { "type": "number", "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, "format": "float" }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -20131,7 +20183,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -20141,7 +20193,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -20164,7 +20216,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -20225,7 +20277,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -20235,7 +20287,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -20248,13 +20300,12 @@ "properties": { "key": { "type": "string", - "description": "Index Key.", - "x-example": null + "description": "Index Key." }, "type": { "type": "string", "description": "Index type.", - "x-example": "key", + "example": "key", "enum": [ "key", "fulltext", @@ -20270,7 +20321,6 @@ "attributes": { "type": "array", "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "x-example": null, "items": { "type": "string" } @@ -20279,7 +20329,6 @@ "type": "array", "description": "Array of index orders. Maximum of 100 orders are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -20297,7 +20346,6 @@ "type": "array", "description": "Length of index. Maximum of 100", "default": [], - "x-example": null, "items": { "type": "integer" } @@ -20369,7 +20417,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -20379,7 +20427,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -20441,7 +20489,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -20451,7 +20499,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -20521,7 +20569,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -20535,8 +20583,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -20599,7 +20647,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -20609,7 +20657,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -20620,7 +20668,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -20632,7 +20680,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -20694,7 +20742,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -20755,7 +20803,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -20847,7 +20895,6 @@ "texts": { "type": "array", "description": "Array of text to generate embeddings.", - "x-example": null, "items": { "type": "string" } @@ -20856,7 +20903,7 @@ "type": "string", "description": "The embedding model to use for generating vector embeddings.", "default": "nomic-embed-text", - "x-example": "nomic-embed-text", + "example": "nomic-embed-text", "enum": [ "nomic-embed-text", "embedding-gemma", @@ -20948,7 +20995,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -20959,7 +21006,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -21021,7 +21068,7 @@ "functionId": { "type": "string", "description": "Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<FUNCTION_ID>", + "example": "<FUNCTION_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -21029,12 +21076,12 @@ "name": { "type": "string", "description": "Function name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "runtime": { "type": "string", "description": "Execution runtime.", - "x-example": "node-14.5", + "example": "node-14.5", "enum": [ "node-14.5", "node-16.0", @@ -21068,9 +21115,6 @@ "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", @@ -21166,9 +21210,6 @@ "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", @@ -21235,7 +21276,9 @@ "type": "array", "description": "An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.", "default": [], - "x-example": "[\"any\"]", + "example": [ + "any" + ], "items": { "type": "string" } @@ -21244,7 +21287,6 @@ "type": "array", "description": "Events list. Maximum of 100 events are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -21252,45 +21294,43 @@ "schedule": { "type": "string", "description": "Schedule CRON syntax.", - "default": "", - "x-example": null + "default": "" }, "timeout": { "type": "integer", "description": "Function maximum execution time in seconds.", "default": 15, - "x-example": 1, + "example": 1, "format": "int32" }, "enabled": { "type": "boolean", "description": "Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", "default": true, - "x-example": false + "example": false }, "entrypoint": { "type": "string", "description": "Entrypoint File. This path is relative to the \"providerRootDirectory\".", "default": "", - "x-example": "<ENTRYPOINT>" + "example": "<ENTRYPOINT>" }, "commands": { "type": "string", "description": "Build Commands.", "default": "", - "x-example": "<COMMANDS>" + "example": "<COMMANDS>" }, "scopes": { "type": "array", "description": "List of scopes allowed for API key auto-generated for every execution. Maximum of 200 scopes are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -21514,37 +21554,36 @@ "type": "string", "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", "default": "", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "providerRepositoryId": { "type": "string", "description": "Repository ID of the repo linked to the function.", "default": "", - "x-example": "<PROVIDER_REPOSITORY_ID>" + "example": "<PROVIDER_REPOSITORY_ID>" }, "providerBranch": { "type": "string", "description": "Production branch for the repo linked to the function.", "default": "", - "x-example": "<PROVIDER_BRANCH>" + "example": "<PROVIDER_BRANCH>" }, "providerSilentMode": { "type": "boolean", "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.", "default": false, - "x-example": false + "example": false }, "providerRootDirectory": { "type": "string", "description": "Path to function code in the linked repo.", "default": "", - "x-example": "<PROVIDER_ROOT_DIRECTORY>" + "example": "<PROVIDER_ROOT_DIRECTORY>" }, "providerBranches": { "type": "array", "description": "List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -21553,7 +21592,6 @@ "type": "array", "description": "List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -21561,20 +21599,18 @@ "buildSpecification": { "type": "string", "description": "Build specification for the function deployments.", - "default": {}, - "x-example": null + "default": {} }, "runtimeSpecification": { "type": "string", "description": "Runtime specification for the function executions.", - "default": {}, - "x-example": null + "default": {} }, "deploymentRetention": { "type": "integer", "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -21692,7 +21728,7 @@ "required": false, "schema": { "type": "string", - "x-example": "runtimes", + "example": "runtimes", "default": "runtimes" }, "in": "query" @@ -21754,7 +21790,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" } @@ -21813,7 +21849,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" } @@ -21827,12 +21863,12 @@ "name": { "type": "string", "description": "Function name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "runtime": { "type": "string", "description": "Execution runtime.", - "x-example": "node-14.5", + "example": "node-14.5", "enum": [ "node-14.5", "node-16.0", @@ -21866,9 +21902,6 @@ "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", @@ -21964,9 +21997,6 @@ "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", @@ -22033,7 +22063,9 @@ "type": "array", "description": "An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.", "default": [], - "x-example": "[\"any\"]", + "example": [ + "any" + ], "items": { "type": "string" } @@ -22042,7 +22074,6 @@ "type": "array", "description": "Events list. Maximum of 100 events are allowed.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -22050,45 +22081,43 @@ "schedule": { "type": "string", "description": "Schedule CRON syntax.", - "default": "", - "x-example": null + "default": "" }, "timeout": { "type": "integer", "description": "Maximum execution time in seconds.", "default": 15, - "x-example": 1, + "example": 1, "format": "int32" }, "enabled": { "type": "boolean", "description": "Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", "default": true, - "x-example": false + "example": false }, "entrypoint": { "type": "string", "description": "Entrypoint File. This path is relative to the \"providerRootDirectory\".", "default": "", - "x-example": "<ENTRYPOINT>" + "example": "<ENTRYPOINT>" }, "commands": { "type": "string", "description": "Build Commands.", "default": "", - "x-example": "<COMMANDS>" + "example": "<COMMANDS>" }, "scopes": { "type": "array", "description": "List of scopes allowed for API Key auto-generated for every execution. Maximum of 200 scopes are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -22312,67 +22341,63 @@ "type": "string", "description": "Appwrite Installation ID for VCS (Version Controle System) deployment.", "default": "", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "providerRepositoryId": { "type": "string", "description": "Repository ID of the repo linked to the function", - "x-example": "<PROVIDER_REPOSITORY_ID>", - "x-nullable": true + "example": "<PROVIDER_REPOSITORY_ID>", + "nullable": true }, "providerBranch": { "type": "string", "description": "Production branch for the repo linked to the function", "default": "", - "x-example": "<PROVIDER_BRANCH>" + "example": "<PROVIDER_BRANCH>" }, "providerSilentMode": { "type": "boolean", "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.", "default": false, - "x-example": false + "example": false }, "providerRootDirectory": { "type": "string", "description": "Path to function code in the linked repo.", "default": "", - "x-example": "<PROVIDER_ROOT_DIRECTORY>" + "example": "<PROVIDER_ROOT_DIRECTORY>" }, "providerBranches": { "type": "array", "description": "List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "providerPaths": { "type": "array", "description": "List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "buildSpecification": { "type": "string", "description": "Build specification for the function deployments.", - "x-example": null, - "x-nullable": true + "nullable": true }, "runtimeSpecification": { "type": "string", "description": "Runtime specification for the function executions.", - "x-example": null, - "x-nullable": true + "nullable": true }, "deploymentRetention": { "type": "integer", "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -22430,7 +22455,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" } @@ -22491,7 +22516,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" } @@ -22505,7 +22530,7 @@ "deploymentId": { "type": "string", "description": "Deployment ID.", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" } }, "required": [ @@ -22571,7 +22596,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -22594,7 +22619,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -22605,7 +22630,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -22665,7 +22690,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" } @@ -22679,25 +22704,24 @@ "entrypoint": { "type": "string", "description": "Entrypoint File.", - "x-example": "<ENTRYPOINT>", - "x-nullable": true + "example": "<ENTRYPOINT>", + "nullable": true }, "commands": { "type": "string", "description": "Build Commands.", - "x-example": "<COMMANDS>", - "x-nullable": true + "example": "<COMMANDS>", + "nullable": true }, "code": { "type": "string", "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", - "x-example": null, "format": "binary" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", - "x-example": false + "example": false } }, "required": [ @@ -22764,7 +22788,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" } @@ -22778,13 +22802,13 @@ "deploymentId": { "type": "string", "description": "Deployment ID.", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "buildId": { "type": "string", "description": "Build unique ID.", "default": "", - "x-example": "<BUILD_ID>" + "example": "<BUILD_ID>" } }, "required": [ @@ -22850,7 +22874,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" } @@ -22864,22 +22888,22 @@ "repository": { "type": "string", "description": "Repository name of the template.", - "x-example": "<REPOSITORY>" + "example": "<REPOSITORY>" }, "owner": { "type": "string", "description": "The name of the owner of the template.", - "x-example": "<OWNER>" + "example": "<OWNER>" }, "rootDirectory": { "type": "string", "description": "Path to function code in the template repo.", - "x-example": "<ROOT_DIRECTORY>" + "example": "<ROOT_DIRECTORY>" }, "type": { "type": "string", "description": "Type for the reference provided. Can be commit, branch, or tag", - "x-example": "commit", + "example": "commit", "enum": [ "commit", "branch", @@ -22895,13 +22919,13 @@ "reference": { "type": "string", "description": "Reference value, can be a commit hash, branch name, or release tag", - "x-example": "<REFERENCE>" + "example": "<REFERENCE>" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -22971,7 +22995,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" } @@ -22985,7 +23009,7 @@ "type": { "type": "string", "description": "Type of reference passed. Allowed values are: branch, commit", - "x-example": "branch", + "example": "branch", "enum": [ "branch", "commit" @@ -22999,13 +23023,13 @@ "reference": { "type": "string", "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", - "x-example": "<REFERENCE>" + "example": "<REFERENCE>" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -23072,7 +23096,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -23082,7 +23106,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" } @@ -23134,7 +23158,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -23144,7 +23168,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" } @@ -23212,7 +23236,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -23222,7 +23246,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" }, @@ -23232,7 +23256,7 @@ "required": false, "schema": { "type": "string", - "x-example": "source", + "example": "source", "enum": [ "source", "output" @@ -23252,7 +23276,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TOKEN>", + "example": "<TOKEN>", "default": "" }, "in": "query" @@ -23314,7 +23338,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -23324,7 +23348,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" } @@ -23391,7 +23415,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -23414,7 +23438,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -23480,7 +23504,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" } @@ -23495,25 +23519,25 @@ "type": "string", "description": "HTTP body of execution. Default value is empty string.", "default": "", - "x-example": "<BODY>" + "example": "<BODY>" }, "async": { "type": "boolean", "description": "Execute code in the background. Default value is false.", "default": false, - "x-example": false + "example": false }, "path": { "type": "string", "description": "HTTP path of execution. Path can include query params. Default value is \/", "default": "\/", - "x-example": "<PATH>" + "example": "<PATH>" }, "method": { "type": "string", "description": "HTTP method of execution. Default value is POST.", "default": "POST", - "x-example": "GET", + "example": "GET", "enum": [ "GET", "POST", @@ -23538,13 +23562,13 @@ "type": "object", "description": "HTTP headers of execution. Defaults to empty.", "default": [], - "x-example": "{}" + "example": {} }, "scheduledAt": { "type": "string", "description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.", - "x-example": "<SCHEDULED_AT>", - "x-nullable": true + "example": "<SCHEDULED_AT>", + "nullable": true } } } @@ -23613,7 +23637,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -23623,7 +23647,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<EXECUTION_ID>" + "example": "<EXECUTION_ID>" }, "in": "path" } @@ -23678,7 +23702,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -23688,7 +23712,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<EXECUTION_ID>" + "example": "<EXECUTION_ID>" }, "in": "path" } @@ -23749,7 +23773,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -23772,7 +23796,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -23832,7 +23856,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" } @@ -23846,7 +23870,7 @@ "variableId": { "type": "string", "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<VARIABLE_ID>", + "example": "<VARIABLE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -23854,18 +23878,18 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "<KEY>" + "example": "<KEY>" }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "<VALUE>" + "example": "<VALUE>" }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -23933,7 +23957,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -23943,7 +23967,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -24002,7 +24026,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -24012,7 +24036,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -24026,20 +24050,20 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "<KEY>", - "x-nullable": true + "example": "<KEY>", + "nullable": true }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "<VALUE>", - "x-nullable": true + "example": "<VALUE>", + "nullable": true }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -24093,7 +24117,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "in": "path" }, @@ -24103,7 +24127,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -24171,7 +24195,7 @@ "type": "object", "description": "The query or queries to execute.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -24244,7 +24268,7 @@ "type": "object", "description": "The query or queries to execute.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -24748,7 +24772,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -24759,7 +24783,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -24824,7 +24848,7 @@ "messageId": { "type": "string", "description": "Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<MESSAGE_ID>", + "example": "<MESSAGE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -24832,18 +24856,17 @@ "subject": { "type": "string", "description": "Email Subject.", - "x-example": "<SUBJECT>" + "example": "<SUBJECT>" }, "content": { "type": "string", "description": "Email Content.", - "x-example": "<CONTENT>" + "example": "<CONTENT>" }, "topics": { "type": "array", "description": "List of Topic IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -24852,7 +24875,6 @@ "type": "array", "description": "List of User IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -24861,7 +24883,6 @@ "type": "array", "description": "List of Targets IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -24870,7 +24891,6 @@ "type": "array", "description": "Array of target IDs to be added as CC.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -24879,7 +24899,6 @@ "type": "array", "description": "Array of target IDs to be added as BCC.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -24888,7 +24907,6 @@ "type": "array", "description": "Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -24897,20 +24915,20 @@ "type": "boolean", "description": "Is message a draft", "default": false, - "x-example": false + "example": false }, "html": { "type": "boolean", "description": "Is content of type HTML", "default": false, - "x-example": false + "example": false }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -24979,7 +24997,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" } @@ -24993,87 +25011,81 @@ "topics": { "type": "array", "description": "List of Topic IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "users": { "type": "array", "description": "List of User IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "targets": { "type": "array", "description": "List of Targets IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "subject": { "type": "string", "description": "Email Subject.", - "x-example": "<SUBJECT>", - "x-nullable": true + "example": "<SUBJECT>", + "nullable": true }, "content": { "type": "string", "description": "Email Content.", - "x-example": "<CONTENT>", - "x-nullable": true + "example": "<CONTENT>", + "nullable": true }, "draft": { "type": "boolean", "description": "Is message a draft", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "html": { "type": "boolean", "description": "Is content of type HTML", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "cc": { "type": "array", "description": "Array of target IDs to be added as CC.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "bcc": { "type": "array", "description": "Array of target IDs to be added as BCC.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "attachments": { "type": "array", "description": "Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true } } } @@ -25139,7 +25151,7 @@ "messageId": { "type": "string", "description": "Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<MESSAGE_ID>", + "example": "<MESSAGE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -25148,19 +25160,18 @@ "type": "string", "description": "Title for push notification.", "default": "", - "x-example": "<TITLE>" + "example": "<TITLE>" }, "body": { "type": "string", "description": "Body for push notification.", "default": "", - "x-example": "<BODY>" + "example": "<BODY>" }, "topics": { "type": "array", "description": "List of Topic IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -25169,7 +25180,6 @@ "type": "array", "description": "List of User IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -25178,7 +25188,6 @@ "type": "array", "description": "List of Targets IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -25187,82 +25196,81 @@ "type": "object", "description": "Additional key-value pair data for push notification.", "default": {}, - "x-example": "{}", - "x-nullable": true + "example": {}, + "nullable": true }, "action": { "type": "string", "description": "Action for push notification.", "default": "", - "x-example": "<ACTION>" + "example": "<ACTION>" }, "image": { "type": "string", "description": "Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.", "default": "", - "x-example": "<ID1:ID2>" + "example": "<ID1:ID2>" }, "icon": { "type": "string", "description": "Icon for push notification. Available only for Android and Web Platform.", "default": "", - "x-example": "<ICON>" + "example": "<ICON>" }, "sound": { "type": "string", "description": "Sound for push notification. Available only for Android and iOS Platform.", "default": "", - "x-example": "<SOUND>" + "example": "<SOUND>" }, "color": { "type": "string", "description": "Color for push notification. Available only for Android Platform.", "default": "", - "x-example": "<COLOR>" + "example": "<COLOR>" }, "tag": { "type": "string", "description": "Tag for push notification. Available only for Android Platform.", "default": "", - "x-example": "<TAG>" + "example": "<TAG>" }, "badge": { "type": "integer", "description": "Badge for push notification. Available only for iOS Platform.", "default": -1, - "x-example": null, "format": "int32" }, "draft": { "type": "boolean", "description": "Is message a draft", "default": false, - "x-example": false + "example": false }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "contentAvailable": { "type": "boolean", "description": "If set to true, the notification will be delivered in the background. Available only for iOS Platform.", "default": false, - "x-example": false + "example": false }, "critical": { "type": "boolean", "description": "If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.", "default": false, - "x-example": false + "example": false }, "priority": { "type": "string", "description": "Set the notification priority. \"normal\" will consider device state and may not deliver notifications immediately. \"high\" will always attempt to immediately deliver the notification.", "default": "high", - "x-example": "normal", + "example": "normal", "enum": [ "normal", "high" @@ -25338,7 +25346,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" } @@ -25352,121 +25360,117 @@ "topics": { "type": "array", "description": "List of Topic IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "users": { "type": "array", "description": "List of User IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "targets": { "type": "array", "description": "List of Targets IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "title": { "type": "string", "description": "Title for push notification.", - "x-example": "<TITLE>", - "x-nullable": true + "example": "<TITLE>", + "nullable": true }, "body": { "type": "string", "description": "Body for push notification.", - "x-example": "<BODY>", - "x-nullable": true + "example": "<BODY>", + "nullable": true }, "data": { "type": "object", "description": "Additional Data for push notification.", "default": {}, - "x-example": "{}", - "x-nullable": true + "example": {}, + "nullable": true }, "action": { "type": "string", "description": "Action for push notification.", - "x-example": "<ACTION>", - "x-nullable": true + "example": "<ACTION>", + "nullable": true }, "image": { "type": "string", "description": "Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.", - "x-example": "<ID1:ID2>", - "x-nullable": true + "example": "<ID1:ID2>", + "nullable": true }, "icon": { "type": "string", "description": "Icon for push notification. Available only for Android and Web platforms.", - "x-example": "<ICON>", - "x-nullable": true + "example": "<ICON>", + "nullable": true }, "sound": { "type": "string", "description": "Sound for push notification. Available only for Android and iOS platforms.", - "x-example": "<SOUND>", - "x-nullable": true + "example": "<SOUND>", + "nullable": true }, "color": { "type": "string", "description": "Color for push notification. Available only for Android platforms.", - "x-example": "<COLOR>", - "x-nullable": true + "example": "<COLOR>", + "nullable": true }, "tag": { "type": "string", "description": "Tag for push notification. Available only for Android platforms.", - "x-example": "<TAG>", - "x-nullable": true + "example": "<TAG>", + "nullable": true }, "badge": { "type": "integer", "description": "Badge for push notification. Available only for iOS platforms.", - "x-example": null, "format": "int32", - "x-nullable": true + "nullable": true }, "draft": { "type": "boolean", "description": "Is message a draft", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "contentAvailable": { "type": "boolean", "description": "If set to true, the notification will be delivered in the background. Available only for iOS Platform.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "critical": { "type": "boolean", "description": "If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "priority": { "type": "string", "description": "Set the notification priority. \"normal\" will consider device battery state and may send notifications later. \"high\" will always attempt to immediately deliver the notification.", - "x-example": "normal", + "example": "normal", "enum": [ "normal", "high" @@ -25476,7 +25480,7 @@ "normal", "high" ], - "x-nullable": true + "nullable": true } } } @@ -25614,7 +25618,7 @@ "messageId": { "type": "string", "description": "Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<MESSAGE_ID>", + "example": "<MESSAGE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -25622,13 +25626,12 @@ "content": { "type": "string", "description": "SMS Content.", - "x-example": "<CONTENT>" + "example": "<CONTENT>" }, "topics": { "type": "array", "description": "List of Topic IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -25637,7 +25640,6 @@ "type": "array", "description": "List of User IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -25646,7 +25648,6 @@ "type": "array", "description": "List of Targets IDs.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -25655,14 +25656,14 @@ "type": "boolean", "description": "Is message a draft", "default": false, - "x-example": false + "example": false }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -25800,7 +25801,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" } @@ -25814,48 +25815,45 @@ "topics": { "type": "array", "description": "List of Topic IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "users": { "type": "array", "description": "List of User IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "targets": { "type": "array", "description": "List of Targets IDs.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "content": { "type": "string", "description": "Email Content.", - "x-example": "<CONTENT>", - "x-nullable": true + "example": "<CONTENT>", + "nullable": true }, "draft": { "type": "boolean", "description": "Is message a draft", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "scheduledAt": { "type": "string", "description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -25919,7 +25917,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" } @@ -25972,7 +25970,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" } @@ -26034,7 +26032,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MESSAGE_ID>" + "example": "<MESSAGE_ID>" }, "in": "path" }, @@ -26057,7 +26055,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -26133,7 +26131,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -26144,7 +26142,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -26283,7 +26281,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -26291,43 +26289,43 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "authKey": { "type": "string", "description": "APNS authentication key.", "default": "", - "x-example": "<AUTH_KEY>" + "example": "<AUTH_KEY>" }, "authKeyId": { "type": "string", "description": "APNS authentication key ID.", "default": "", - "x-example": "<AUTH_KEY_ID>" + "example": "<AUTH_KEY_ID>" }, "teamId": { "type": "string", "description": "APNS team ID.", "default": "", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "bundleId": { "type": "string", "description": "APNS bundle ID.", "default": "", - "x-example": "<BUNDLE_ID>" + "example": "<BUNDLE_ID>" }, "sandbox": { "type": "boolean", "description": "Use APNS sandbox environment.", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -26467,7 +26465,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -26482,43 +26480,43 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "authKey": { "type": "string", "description": "APNS authentication key.", "default": "", - "x-example": "<AUTH_KEY>" + "example": "<AUTH_KEY>" }, "authKeyId": { "type": "string", "description": "APNS authentication key ID.", "default": "", - "x-example": "<AUTH_KEY_ID>" + "example": "<AUTH_KEY_ID>" }, "teamId": { "type": "string", "description": "APNS team ID.", "default": "", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "bundleId": { "type": "string", "description": "APNS bundle ID.", "default": "", - "x-example": "<BUNDLE_ID>" + "example": "<BUNDLE_ID>" }, "sandbox": { "type": "boolean", "description": "Use APNS sandbox environment.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -26650,7 +26648,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -26658,20 +26656,20 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "serviceAccountJSON": { "type": "object", "description": "FCM service account JSON.", "default": {}, - "x-example": "{}", - "x-nullable": true + "example": {}, + "nullable": true }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -26803,7 +26801,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -26818,20 +26816,20 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "serviceAccountJSON": { "type": "object", "description": "FCM service account JSON.", "default": {}, - "x-example": "{}", - "x-nullable": true + "example": {}, + "nullable": true } } } @@ -26897,7 +26895,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -26905,57 +26903,57 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "apiKey": { "type": "string", "description": "Mailgun API Key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "domain": { "type": "string", "description": "Mailgun Domain.", "default": "", - "x-example": "<DOMAIN>" + "example": "<DOMAIN>" }, "isEuRegion": { "type": "boolean", "description": "Set as EU region.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -27023,7 +27021,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -27038,56 +27036,56 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "apiKey": { "type": "string", "description": "Mailgun API Key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "domain": { "type": "string", "description": "Mailgun Domain.", "default": "", - "x-example": "<DOMAIN>" + "example": "<DOMAIN>" }, "isEuRegion": { "type": "boolean", "description": "Set as EU region.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "example": "<REPLY_TO_EMAIL>" } } } @@ -27153,7 +27151,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -27161,31 +27159,31 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "templateId": { "type": "string", "description": "Msg91 template ID", "default": "", - "x-example": "<TEMPLATE_ID>" + "example": "<TEMPLATE_ID>" }, "senderId": { "type": "string", "description": "Msg91 sender ID.", "default": "", - "x-example": "<SENDER_ID>" + "example": "<SENDER_ID>" }, "authKey": { "type": "string", "description": "Msg91 auth key.", "default": "", - "x-example": "<AUTH_KEY>" + "example": "<AUTH_KEY>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -27253,7 +27251,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -27268,31 +27266,31 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "templateId": { "type": "string", "description": "Msg91 template ID.", "default": "", - "x-example": "<TEMPLATE_ID>" + "example": "<TEMPLATE_ID>" }, "senderId": { "type": "string", "description": "Msg91 sender ID.", "default": "", - "x-example": "<SENDER_ID>" + "example": "<SENDER_ID>" }, "authKey": { "type": "string", "description": "Msg91 auth key.", "default": "", - "x-example": "<AUTH_KEY>" + "example": "<AUTH_KEY>" } } } @@ -27358,7 +27356,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -27366,45 +27364,45 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "apiKey": { "type": "string", "description": "Resend API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -27472,7 +27470,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -27487,44 +27485,44 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "apiKey": { "type": "string", "description": "Resend API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "example": "<REPLY_TO_EMAIL>" } } } @@ -27590,7 +27588,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -27598,45 +27596,45 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "apiKey": { "type": "string", "description": "Sendgrid API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -27704,7 +27702,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -27719,44 +27717,44 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "apiKey": { "type": "string", "description": "Sendgrid API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "example": "<REPLY_TO_EMAIL>" } } } @@ -27822,7 +27820,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -27830,57 +27828,57 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "accessKey": { "type": "string", "description": "AWS access key ID.", "default": "", - "x-example": "<ACCESS_KEY>" + "example": "<ACCESS_KEY>" }, "secretKey": { "type": "string", "description": "AWS secret access key.", "default": "", - "x-example": "<SECRET_KEY>" + "example": "<SECRET_KEY>" }, "region": { "type": "string", "description": "AWS region, for example us-east-1.", "default": "", - "x-example": "<REGION>" + "example": "<REGION>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -27948,7 +27946,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -27963,56 +27961,56 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "accessKey": { "type": "string", "description": "AWS access key ID.", "default": "", - "x-example": "<ACCESS_KEY>" + "example": "<ACCESS_KEY>" }, "secretKey": { "type": "string", "description": "AWS secret access key.", "default": "", - "x-example": "<SECRET_KEY>" + "example": "<SECRET_KEY>" }, "region": { "type": "string", "description": "AWS region, for example us-east-1.", "default": "", - "x-example": "<REGION>" + "example": "<REGION>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "example": "<REPLY_TO_EMAIL>" } } } @@ -28166,7 +28164,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -28174,37 +28172,37 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "host": { "type": "string", "description": "SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.", - "x-example": "<HOST>" + "example": "<HOST>" }, "port": { "type": "integer", "description": "The default SMTP server port.", "default": 587, - "x-example": 1, + "example": 1, "format": "int32" }, "username": { "type": "string", "description": "Authentication username.", "default": "", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "password": { "type": "string", "description": "Authentication password.", "default": "", - "x-example": "password", + "example": "password", "format": "password" }, "encryption": { "type": "string", "description": "Encryption type. Can be omitted, 'ssl', or 'tls'", - "x-example": "none", + "example": "none", "enum": [ "none", "ssl", @@ -28221,45 +28219,45 @@ "type": "boolean", "description": "Enable SMTP AutoTLS feature.", "default": true, - "x-example": false + "example": false }, "mailer": { "type": "string", "description": "The value to use for the X-Mailer header.", "default": "", - "x-example": "<MAILER>" + "example": "<MAILER>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the reply to field for the mail. Default value is sender name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the reply to field for the mail. Default value is sender email.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -28412,7 +28410,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -28427,38 +28425,38 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "host": { "type": "string", "description": "SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.", "default": "", - "x-example": "<HOST>" + "example": "<HOST>" }, "port": { "type": "integer", "description": "SMTP port.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "username": { "type": "string", "description": "Authentication username.", "default": "", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "password": { "type": "string", "description": "Authentication password.", "default": "", - "x-example": "password", + "example": "password", "format": "password" }, "encryption": { "type": "string", "description": "Encryption type. Can be 'ssl' or 'tls'", - "x-example": "none", + "example": "none", "enum": [ "none", "ssl", @@ -28474,45 +28472,45 @@ "autoTLS": { "type": "boolean", "description": "Enable SMTP AutoTLS feature.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "mailer": { "type": "string", "description": "The value to use for the X-Mailer header.", "default": "", - "x-example": "<MAILER>" + "example": "<MAILER>" }, "fromName": { "type": "string", "description": "Sender Name.", "default": "", - "x-example": "<FROM_NAME>" + "example": "<FROM_NAME>" }, "fromEmail": { "type": "string", "description": "Sender email address.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "replyToName": { "type": "string", "description": "Name set in the Reply To field for the mail. Default value is Sender Name.", "default": "", - "x-example": "<REPLY_TO_NAME>" + "example": "<REPLY_TO_NAME>" }, "replyToEmail": { "type": "string", "description": "Email set in the Reply To field for the mail. Default value is Sender Email.", "default": "", - "x-example": "<REPLY_TO_EMAIL>" + "example": "<REPLY_TO_EMAIL>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -28578,7 +28576,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -28586,32 +28584,32 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "from": { "type": "string", "description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "customerId": { "type": "string", "description": "Telesign customer ID.", "default": "", - "x-example": "<CUSTOMER_ID>" + "example": "<CUSTOMER_ID>" }, "apiKey": { "type": "string", "description": "Telesign API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -28679,7 +28677,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -28694,31 +28692,31 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "customerId": { "type": "string", "description": "Telesign customer ID.", "default": "", - "x-example": "<CUSTOMER_ID>" + "example": "<CUSTOMER_ID>" }, "apiKey": { "type": "string", "description": "Telesign API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "from": { "type": "string", "description": "Sender number.", "default": "", - "x-example": "<FROM>" + "example": "<FROM>" } } } @@ -28784,7 +28782,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -28792,32 +28790,32 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "from": { "type": "string", "description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "username": { "type": "string", "description": "Textmagic username.", "default": "", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "apiKey": { "type": "string", "description": "Textmagic apiKey.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -28885,7 +28883,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -28900,31 +28898,31 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "username": { "type": "string", "description": "Textmagic username.", "default": "", - "x-example": "<USERNAME>" + "example": "<USERNAME>" }, "apiKey": { "type": "string", "description": "Textmagic apiKey.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "from": { "type": "string", "description": "Sender number.", "default": "", - "x-example": "<FROM>" + "example": "<FROM>" } } } @@ -28990,7 +28988,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -28998,32 +28996,32 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "from": { "type": "string", "description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "accountSid": { "type": "string", "description": "Twilio account secret ID.", "default": "", - "x-example": "<ACCOUNT_SID>" + "example": "<ACCOUNT_SID>" }, "authToken": { "type": "string", "description": "Twilio authentication token.", "default": "", - "x-example": "<AUTH_TOKEN>" + "example": "<AUTH_TOKEN>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -29091,7 +29089,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -29106,31 +29104,31 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "accountSid": { "type": "string", "description": "Twilio account secret ID.", "default": "", - "x-example": "<ACCOUNT_SID>" + "example": "<ACCOUNT_SID>" }, "authToken": { "type": "string", "description": "Twilio authentication token.", "default": "", - "x-example": "<AUTH_TOKEN>" + "example": "<AUTH_TOKEN>" }, "from": { "type": "string", "description": "Sender number.", "default": "", - "x-example": "<FROM>" + "example": "<FROM>" } } } @@ -29196,7 +29194,7 @@ "providerId": { "type": "string", "description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PROVIDER_ID>", + "example": "<PROVIDER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -29204,32 +29202,32 @@ "name": { "type": "string", "description": "Provider name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "from": { "type": "string", "description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "apiKey": { "type": "string", "description": "Vonage API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "apiSecret": { "type": "string", "description": "Vonage API secret.", "default": "", - "x-example": "<API_SECRET>" + "example": "<API_SECRET>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } }, "required": [ @@ -29297,7 +29295,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -29312,31 +29310,31 @@ "type": "string", "description": "Provider name.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Set as enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "apiKey": { "type": "string", "description": "Vonage API key.", "default": "", - "x-example": "<API_KEY>" + "example": "<API_KEY>" }, "apiSecret": { "type": "string", "description": "Vonage API secret.", "default": "", - "x-example": "<API_SECRET>" + "example": "<API_SECRET>" }, "from": { "type": "string", "description": "Sender number.", "default": "", - "x-example": "<FROM>" + "example": "<FROM>" } } } @@ -29400,7 +29398,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -29453,7 +29451,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "in": "path" } @@ -29528,7 +29526,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -29539,7 +29537,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -29602,7 +29600,7 @@ "topicId": { "type": "string", "description": "Topic ID. Choose a custom Topic ID or a new Topic ID.", - "x-example": "<TOPIC_ID>", + "example": "<TOPIC_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -29610,7 +29608,7 @@ "name": { "type": "string", "description": "Topic Name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "subscribe": { "type": "array", @@ -29618,7 +29616,9 @@ "default": [ "users" ], - "x-example": "[\"any\"]", + "example": [ + "any" + ], "items": { "type": "string" } @@ -29689,7 +29689,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" } @@ -29749,7 +29749,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" } @@ -29763,17 +29763,19 @@ "name": { "type": "string", "description": "Topic Name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "subscribe": { "type": "array", "description": "An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.", - "x-example": "[\"any\"]", + "example": [ + "any" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true } } } @@ -29828,7 +29830,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" } @@ -29890,7 +29892,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" }, @@ -29913,7 +29915,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -29924,7 +29926,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -29988,7 +29990,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" } @@ -30002,7 +30004,7 @@ "subscriberId": { "type": "string", "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", - "x-example": "<SUBSCRIBER_ID>", + "example": "<SUBSCRIBER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -30010,7 +30012,7 @@ "targetId": { "type": "string", "description": "Target ID. The target ID to link to the specified Topic ID.", - "x-example": "<TARGET_ID>" + "example": "<TARGET_ID>" } }, "required": [ @@ -30078,7 +30080,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" }, @@ -30088,7 +30090,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SUBSCRIBER_ID>" + "example": "<SUBSCRIBER_ID>" }, "in": "path" } @@ -30144,7 +30146,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOPIC_ID>" + "example": "<TOPIC_ID>" }, "in": "path" }, @@ -30154,7 +30156,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SUBSCRIBER_ID>" + "example": "<SUBSCRIBER_ID>" }, "in": "path" } @@ -30279,7 +30281,7 @@ "databaseId": { "type": "string", "description": "Database ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -30287,87 +30289,86 @@ "name": { "type": "string", "description": "Database display name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "version": { "type": "string", "description": "Database engine version. Defaults to latest for selected engine.", - "x-example": "17", - "x-nullable": true + "example": "17", + "nullable": true }, "specification": { "type": "string", "description": "Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.", "default": "s-1vcpu-1gb", - "x-example": "<SPECIFICATION>" + "example": "<SPECIFICATION>" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds.", "default": 900, - "x-example": 60, + "example": 60, "format": "int32" }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes of inactivity before container scales to zero.", "default": 15, - "x-example": 5, + "example": 5, "format": "int32" }, "pitr": { "type": "boolean", "description": "Enable point-in-time recovery (PITR). Continuously archives changes so the database can be restored to any moment within the retention window.", "default": true, - "x-example": false + "example": false }, "pitrRetentionDays": { "type": "integer", "description": "Number of days to retain PITR data.", "default": 7, - "x-example": 1, + "example": 1, "format": "int32" }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", "default": false, - "x-example": false + "example": false }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", "default": 85, - "x-example": 50, + "example": 50, "format": "int32" }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -30484,7 +30485,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -30543,7 +30544,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -30557,139 +30558,136 @@ "name": { "type": "string", "description": "Database display name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "status": { "type": "string", "description": "Database status. Allowed values: ready, paused, inactive. Set to \"paused\" to pause, \"ready\" to resume (also recovers a failed database whose infrastructure is healthy), or \"inactive\" to spin down a shared-pool database.", - "x-example": "ready", - "x-nullable": true + "example": "ready", + "nullable": true }, "specification": { "type": "string", "description": "Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds (60-86400).", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes before container scales to zero.", - "x-example": 5, + "example": 5, "format": "int32", - "x-nullable": true + "nullable": true }, "pitr": { "type": "boolean", "description": "Enable or disable point-in-time recovery (PITR).", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "pitrRetentionDays": { "type": "integer", "description": "Days to retain PITR data.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", - "x-example": 50, + "example": 50, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "metricsTraceSampleRate": { "type": "number", "description": "Fraction of queries to trace (0.0\u20131.0). Forwarded to the sidecar.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "metricsSlowQueryLogThresholdMs": { "type": "integer", "description": "Threshold in ms above which queries are logged as slow. Forwarded to the sidecar.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiEnabled": { "type": "boolean", "description": "Enable the SQL API sidecar for this database.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "sqlApiAllowedStatements": { "type": "array", "description": "Statement types the SQL API accepts. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "sqlApiMaxRows": { "type": "integer", "description": "Maximum rows returned per SQL API execution (1-1000000).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiMaxBytes": { "type": "integer", "description": "Maximum serialised SQL API result payload in bytes (1024-104857600).", - "x-example": 1024, + "example": 1024, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiTimeoutSeconds": { "type": "integer", "description": "Per-call SQL API execution timeout in seconds (1-300).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } } } @@ -30746,7 +30744,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -30807,7 +30805,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -30879,7 +30877,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -30894,7 +30892,7 @@ "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" } } } @@ -30957,7 +30955,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -31029,7 +31027,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -31043,7 +31041,7 @@ "policyId": { "type": "string", "description": "Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<POLICY_ID>", + "example": "<POLICY_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -31051,30 +31049,29 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32" }, "type": { "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -31143,7 +31140,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -31153,7 +31150,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -31212,7 +31209,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -31222,7 +31219,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -31236,26 +31233,25 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -31312,7 +31308,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -31322,7 +31318,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -31383,7 +31379,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -31397,40 +31393,40 @@ "provider": { "type": "string", "description": "Storage provider for off-cluster backups. Allowed values: s3 (Amazon S3 or S3-compatible), gcs (Google Cloud Storage), azure (Azure Blob Storage).", - "x-example": "s3" + "example": "s3" }, "bucket": { "type": "string", "description": "Storage bucket or container name.", - "x-example": "<BUCKET>" + "example": "<BUCKET>" }, "region": { "type": "string", "description": "Storage region.", "default": "", - "x-example": "<REGION>" + "example": "<REGION>" }, "prefix": { "type": "string", "description": "Object key prefix for backups.", "default": "backups\/", - "x-example": "<PREFIX>" + "example": "<PREFIX>" }, "endpoint": { "type": "string", "description": "Custom endpoint for S3-compatible storage (e.g. MinIO).", "default": "", - "x-example": "<ENDPOINT>" + "example": "<ENDPOINT>" }, "accessKey": { "type": "string", "description": "Access key or client ID for authentication.", - "x-example": "<ACCESS_KEY>" + "example": "<ACCESS_KEY>" }, "secretKey": { "type": "string", "description": "Secret key or service account JSON for authentication.", - "x-example": "<SECRET_KEY>" + "example": "<SECRET_KEY>" } }, "required": [ @@ -31499,7 +31495,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -31509,7 +31505,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -31564,7 +31560,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -31574,7 +31570,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -31635,7 +31631,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -31694,7 +31690,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -31709,7 +31705,7 @@ "type": "string", "description": "Branch ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": "", - "x-example": "<BRANCH_ID>", + "example": "<BRANCH_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -31718,7 +31714,7 @@ "type": "integer", "description": "Time-to-live in seconds before the branch expires. Min 300 (5 min), max 604800 (7 days). Default: 86400 (24h).", "default": 86400, - "x-example": 300, + "example": 300, "format": "int32" } } @@ -31782,7 +31778,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -31792,7 +31788,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BRANCH_ID>" + "example": "<BRANCH_ID>" }, "in": "path" } @@ -31853,7 +31849,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -31914,7 +31910,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -31928,8 +31924,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -31992,7 +31988,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -32006,12 +32002,12 @@ "day": { "type": "string", "description": "Day of the week for the maintenance window. Allowed values: sun, mon, tue, wed, thu, fri, sat.", - "x-example": "sun" + "example": "sun" }, "hourUtc": { "type": "integer", "description": "Hour in UTC (0-23) for maintenance window start.", - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -32079,7 +32075,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -32093,13 +32089,13 @@ "targetType": { "type": "string", "description": "Target database type to migrate to. Allowed values: shared (serverless, scales to zero when idle), dedicated (always-on with persistent resources).", - "x-example": "shared" + "example": "shared" }, "specification": { "type": "string", "description": "Target specification to provision when migrating to dedicated. Ignored for shared. Defaults to the database's current specification.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true } }, "required": [ @@ -32165,7 +32161,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -32175,7 +32171,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -32186,7 +32182,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -32198,7 +32194,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -32260,7 +32256,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -32321,7 +32317,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -32382,7 +32378,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -32392,7 +32388,7 @@ "required": false, "schema": { "type": "string", - "x-example": "pending" + "example": "pending" }, "in": "query" }, @@ -32402,7 +32398,7 @@ "required": false, "schema": { "type": "string", - "x-example": "backup" + "example": "backup" }, "in": "query" }, @@ -32413,7 +32409,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -32425,7 +32421,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -32485,7 +32481,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -32500,26 +32496,26 @@ "type": "string", "description": "Restoration type. Allowed values: backup, pitr. Use \"backup\" to restore from a specific backup, or \"pitr\" for point-in-time recovery.", "default": "backup", - "x-example": "backup" + "example": "backup" }, "backupId": { "type": "string", "description": "Backup ID to restore from (required for backup type).", - "x-example": "<BACKUP_ID>", - "x-nullable": true + "example": "<BACKUP_ID>", + "nullable": true }, "targetDatabaseId": { "type": "string", "description": "Existing database ID to restore into. The target must be distinct, ready, and use the same engine and version.", - "x-example": "<TARGET_DATABASE_ID>", - "x-nullable": true + "example": "<TARGET_DATABASE_ID>", + "nullable": true }, "targetTime": { "type": "string", "description": "Target time for PITR (required for pitr type) as an [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -32582,7 +32578,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -32592,7 +32588,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RESTORATION_ID>" + "example": "<RESTORATION_ID>" }, "in": "path" } @@ -32653,7 +32649,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -32714,7 +32710,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -32728,7 +32724,7 @@ "targetVersion": { "type": "string", "description": "Target engine version to upgrade to.", - "x-example": "<TARGET_VERSION>" + "example": "<TARGET_VERSION>" } }, "required": [ @@ -32858,7 +32854,7 @@ "databaseId": { "type": "string", "description": "Database ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -32866,87 +32862,86 @@ "name": { "type": "string", "description": "Database display name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "version": { "type": "string", "description": "Database engine version. Defaults to latest for selected engine.", - "x-example": "17", - "x-nullable": true + "example": "17", + "nullable": true }, "specification": { "type": "string", "description": "Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.", "default": "s-1vcpu-1gb", - "x-example": "<SPECIFICATION>" + "example": "<SPECIFICATION>" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds.", "default": 900, - "x-example": 60, + "example": 60, "format": "int32" }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes of inactivity before container scales to zero.", "default": 15, - "x-example": 5, + "example": 5, "format": "int32" }, "pitr": { "type": "boolean", "description": "Enable point-in-time recovery (PITR). Continuously archives changes so the database can be restored to any moment within the retention window.", "default": true, - "x-example": false + "example": false }, "pitrRetentionDays": { "type": "integer", "description": "Number of days to retain PITR data.", "default": 7, - "x-example": 1, + "example": 1, "format": "int32" }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", "default": false, - "x-example": false + "example": false }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", "default": 85, - "x-example": 50, + "example": 50, "format": "int32" }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -33063,7 +33058,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -33122,7 +33117,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -33136,139 +33131,136 @@ "name": { "type": "string", "description": "Database display name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "status": { "type": "string", "description": "Database status. Allowed values: ready, paused, inactive. Set to \"paused\" to pause, \"ready\" to resume (also recovers a failed database whose infrastructure is healthy), or \"inactive\" to spin down a shared-pool database.", - "x-example": "ready", - "x-nullable": true + "example": "ready", + "nullable": true }, "specification": { "type": "string", "description": "Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds (60-86400).", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes before container scales to zero.", - "x-example": 5, + "example": 5, "format": "int32", - "x-nullable": true + "nullable": true }, "pitr": { "type": "boolean", "description": "Enable or disable point-in-time recovery (PITR).", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "pitrRetentionDays": { "type": "integer", "description": "Days to retain PITR data.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", - "x-example": 50, + "example": 50, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "metricsTraceSampleRate": { "type": "number", "description": "Fraction of queries to trace (0.0\u20131.0). Forwarded to the sidecar.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "metricsSlowQueryLogThresholdMs": { "type": "integer", "description": "Threshold in ms above which queries are logged as slow. Forwarded to the sidecar.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiEnabled": { "type": "boolean", "description": "Enable the SQL API sidecar for this database.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "sqlApiAllowedStatements": { "type": "array", "description": "Statement types the SQL API accepts. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "sqlApiMaxRows": { "type": "integer", "description": "Maximum rows returned per SQL API execution (1-1000000).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiMaxBytes": { "type": "integer", "description": "Maximum serialised SQL API result payload in bytes (1024-104857600).", - "x-example": 1024, + "example": 1024, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiTimeoutSeconds": { "type": "integer", "description": "Per-call SQL API execution timeout in seconds (1-300).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } } } @@ -33325,7 +33317,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -33386,7 +33378,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -33458,7 +33450,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -33473,7 +33465,7 @@ "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" } } } @@ -33536,7 +33528,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -33608,7 +33600,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -33622,7 +33614,7 @@ "policyId": { "type": "string", "description": "Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<POLICY_ID>", + "example": "<POLICY_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -33630,30 +33622,29 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32" }, "type": { "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -33722,7 +33713,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -33732,7 +33723,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -33791,7 +33782,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -33801,7 +33792,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -33815,26 +33806,25 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -33891,7 +33881,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -33901,7 +33891,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -33962,7 +33952,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -33976,40 +33966,40 @@ "provider": { "type": "string", "description": "Storage provider for off-cluster backups. Allowed values: s3 (Amazon S3 or S3-compatible), gcs (Google Cloud Storage), azure (Azure Blob Storage).", - "x-example": "s3" + "example": "s3" }, "bucket": { "type": "string", "description": "Storage bucket or container name.", - "x-example": "<BUCKET>" + "example": "<BUCKET>" }, "region": { "type": "string", "description": "Storage region.", "default": "", - "x-example": "<REGION>" + "example": "<REGION>" }, "prefix": { "type": "string", "description": "Object key prefix for backups.", "default": "backups\/", - "x-example": "<PREFIX>" + "example": "<PREFIX>" }, "endpoint": { "type": "string", "description": "Custom endpoint for S3-compatible storage (e.g. MinIO).", "default": "", - "x-example": "<ENDPOINT>" + "example": "<ENDPOINT>" }, "accessKey": { "type": "string", "description": "Access key or client ID for authentication.", - "x-example": "<ACCESS_KEY>" + "example": "<ACCESS_KEY>" }, "secretKey": { "type": "string", "description": "Secret key or service account JSON for authentication.", - "x-example": "<SECRET_KEY>" + "example": "<SECRET_KEY>" } }, "required": [ @@ -34078,7 +34068,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -34088,7 +34078,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -34143,7 +34133,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -34153,7 +34143,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -34214,7 +34204,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -34273,7 +34263,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -34288,7 +34278,7 @@ "type": "string", "description": "Branch ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": "", - "x-example": "<BRANCH_ID>", + "example": "<BRANCH_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -34297,7 +34287,7 @@ "type": "integer", "description": "Time-to-live in seconds before the branch expires. Min 300 (5 min), max 604800 (7 days). Default: 86400 (24h).", "default": 86400, - "x-example": 300, + "example": 300, "format": "int32" } } @@ -34361,7 +34351,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -34371,7 +34361,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BRANCH_ID>" + "example": "<BRANCH_ID>" }, "in": "path" } @@ -34432,7 +34422,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -34493,7 +34483,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -34507,21 +34497,21 @@ "sql": { "type": "string", "description": "SQL statement to execute. Exactly one statement per request.", - "x-example": "<SQL>" + "example": "<SQL>" }, "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 + "example": {}, + "nullable": true }, "timeoutSeconds": { "type": "integer", "description": "Per-call execution timeout override. Must be less than or equal to the database's configured sqlApiTimeoutSeconds.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } }, "required": [ @@ -34587,7 +34577,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -34601,8 +34591,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -34665,7 +34655,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -34679,12 +34669,12 @@ "day": { "type": "string", "description": "Day of the week for the maintenance window. Allowed values: sun, mon, tue, wed, thu, fri, sat.", - "x-example": "sun" + "example": "sun" }, "hourUtc": { "type": "integer", "description": "Hour in UTC (0-23) for maintenance window start.", - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -34752,7 +34742,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -34766,13 +34756,13 @@ "targetType": { "type": "string", "description": "Target database type to migrate to. Allowed values: shared (serverless, scales to zero when idle), dedicated (always-on with persistent resources).", - "x-example": "shared" + "example": "shared" }, "specification": { "type": "string", "description": "Target specification to provision when migrating to dedicated. Ignored for shared. Defaults to the database's current specification.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true } }, "required": [ @@ -34838,7 +34828,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -34848,7 +34838,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -34859,7 +34849,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -34871,7 +34861,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -34933,7 +34923,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -34994,7 +34984,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -35053,7 +35043,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -35067,52 +35057,52 @@ "mode": { "type": "string", "description": "Connection pool mode. Allowed values: transaction, session. Transaction mode returns connections to the pool after each transaction; session mode holds connections for the entire session lifetime.", - "x-example": "transaction", - "x-nullable": true + "example": "transaction", + "nullable": true }, "maxConnections": { "type": "integer", "description": "Client-connection ceiling the pooler accepts. Supported on MySQL and MariaDB only; the PostgreSQL pooler has no client cap, so set networkMaxConnections on the database instead.", - "x-example": 10, + "example": 10, "format": "int32", - "x-nullable": true + "nullable": true }, "defaultPoolSize": { "type": "integer", "description": "Default pool size per user.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "readWriteSplitting": { "type": "boolean", "description": "Route SELECTs to HA replicas, writes and locked reads to the primary. Defaults to true when HA is enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "poolerCpuRequest": { "type": "string", "description": "Pooler sidecar CPU request override (Kubernetes quantity, e.g. \"250m\" or \"1\"). Leave null for the proportional default (5% of DB CPU, floor 100m).", - "x-example": "<POOLER_CPU_REQUEST>", - "x-nullable": true + "example": "<POOLER_CPU_REQUEST>", + "nullable": true }, "poolerCpuLimit": { "type": "string", "description": "Pooler sidecar CPU limit override (Kubernetes quantity, e.g. \"500m\" or \"1\"). Leave null for the proportional default (10% of DB CPU, floor 200m). Changing this field rolls the database pod.", - "x-example": "<POOLER_CPU_LIMIT>", - "x-nullable": true + "example": "<POOLER_CPU_LIMIT>", + "nullable": true }, "poolerMemoryRequest": { "type": "string", "description": "Pooler sidecar memory request override (Kubernetes quantity, e.g. \"128Mi\" or \"1Gi\"). Leave null for the proportional default (7.5% of DB memory, floor 64Mi).", - "x-example": "<POOLER_MEMORY_REQUEST>", - "x-nullable": true + "example": "<POOLER_MEMORY_REQUEST>", + "nullable": true }, "poolerMemoryLimit": { "type": "string", "description": "Pooler sidecar memory limit override (Kubernetes quantity, e.g. \"256Mi\" or \"1Gi\"). Leave null for the proportional default (15% of DB memory, floor 128Mi). Changing this field rolls the database pod.", - "x-example": "<POOLER_MEMORY_LIMIT>", - "x-nullable": true + "example": "<POOLER_MEMORY_LIMIT>", + "nullable": true } } } @@ -35175,7 +35165,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -35236,7 +35226,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -35246,7 +35236,7 @@ "required": false, "schema": { "type": "string", - "x-example": "pending" + "example": "pending" }, "in": "query" }, @@ -35256,7 +35246,7 @@ "required": false, "schema": { "type": "string", - "x-example": "backup" + "example": "backup" }, "in": "query" }, @@ -35267,7 +35257,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -35279,7 +35269,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -35339,7 +35329,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -35354,26 +35344,26 @@ "type": "string", "description": "Restoration type. Allowed values: backup, pitr. Use \"backup\" to restore from a specific backup, or \"pitr\" for point-in-time recovery.", "default": "backup", - "x-example": "backup" + "example": "backup" }, "backupId": { "type": "string", "description": "Backup ID to restore from (required for backup type).", - "x-example": "<BACKUP_ID>", - "x-nullable": true + "example": "<BACKUP_ID>", + "nullable": true }, "targetDatabaseId": { "type": "string", "description": "Existing database ID to restore into. The target must be distinct, ready, and use the same engine and version.", - "x-example": "<TARGET_DATABASE_ID>", - "x-nullable": true + "example": "<TARGET_DATABASE_ID>", + "nullable": true }, "targetTime": { "type": "string", "description": "Target time for PITR (required for pitr type) as an [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -35436,7 +35426,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -35446,7 +35436,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RESTORATION_ID>" + "example": "<RESTORATION_ID>" }, "in": "path" } @@ -35507,7 +35497,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -35568,7 +35558,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -35582,7 +35572,7 @@ "targetVersion": { "type": "string", "description": "Target engine version to upgrade to.", - "x-example": "<TARGET_VERSION>" + "example": "<TARGET_VERSION>" } }, "required": [ @@ -35650,7 +35640,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -35664,19 +35654,19 @@ "grant_id": { "type": "string", "description": "Grant ID made during authorization, provided to consent screen in URL search params.", - "x-example": "<GRANT_ID>" + "example": "<GRANT_ID>" }, "authorization_details": { "type": "string", "description": "Enriched `authorization_details` the user consented to, replacing what the client requested. Each entry must use a `type` the project accepts. Optional; omit to keep the originally requested details.", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" }, "scope": { "type": "string", "description": "Space-separated scopes the user consented to. Must be a subset of the scopes originally requested; identity scopes such as `openid` are always retained. Optional; omit to keep the originally requested scopes.", "default": "", - "x-example": "<SCOPE>" + "example": "<SCOPE>" } }, "required": [ @@ -35744,7 +35734,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -35754,7 +35744,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<CLIENT_ID>", + "example": "<CLIENT_ID>", "default": "" }, "in": "query" @@ -35766,7 +35756,7 @@ "schema": { "type": "string", "format": "url", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "default": "" }, "in": "query" @@ -35777,7 +35767,7 @@ "required": false, "schema": { "type": "string", - "x-example": "", + "example": "", "default": "" }, "in": "query" @@ -35788,7 +35778,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SCOPE>", + "example": "<SCOPE>", "default": "" }, "in": "query" @@ -35799,7 +35789,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<STATE>", + "example": "<STATE>", "default": "" }, "in": "query" @@ -35810,7 +35800,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<NONCE>", + "example": "<NONCE>", "default": "" }, "in": "query" @@ -35821,7 +35811,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<CODE_CHALLENGE>", + "example": "<CODE_CHALLENGE>", "default": "" }, "in": "query" @@ -35832,7 +35822,7 @@ "required": false, "schema": { "type": "string", - "x-example": "s256", + "example": "s256", "default": "" }, "in": "query" @@ -35843,7 +35833,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<PROMPT>", + "example": "<PROMPT>", "default": "" }, "in": "query" @@ -35855,7 +35845,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0 + "example": 0 }, "in": "query" }, @@ -35865,7 +35855,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<AUTHORIZATION_DETAILS>", + "example": "<AUTHORIZATION_DETAILS>", "default": "" }, "in": "query" @@ -35886,7 +35876,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<AUDIENCE>", + "example": "<AUDIENCE>", "default": "" }, "in": "query" @@ -35897,7 +35887,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<REQUEST_URI>", + "example": "<REQUEST_URI>", "default": "" }, "in": "query" @@ -35959,7 +35949,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -35974,87 +35964,86 @@ "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "redirect_uri": { "type": "string", "description": "Redirect URI where visitor will be redirected after authorization, whether successful or not.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "response_type": { "type": "string", "description": "OAuth2 \/ OIDC response type. One of `code` (Authorization Code Flow), `id_token` (Implicit Flow, OIDC login only), or `code id_token` (Hybrid Flow).", "default": "", - "x-example": "" + "example": "" }, "scope": { "type": "string", "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`, `phone`.", "default": "", - "x-example": "<SCOPE>" + "example": "<SCOPE>" }, "state": { "type": "string", "description": "OAuth2 state. You receive this back in the redirect URI.", "default": "", - "x-example": "<STATE>" + "example": "<STATE>" }, "nonce": { "type": "string", "description": "OIDC nonce parameter to prevent replay attacks. Required when response_type includes `id_token`.", "default": "", - "x-example": "<NONCE>" + "example": "<NONCE>" }, "code_challenge": { "type": "string", "description": "PKCE code challenge. Required when OAuth2 app is public.", "default": "", - "x-example": "<CODE_CHALLENGE>" + "example": "<CODE_CHALLENGE>" }, "code_challenge_method": { "type": "string", "description": "PKCE code challenge method. Required when OAuth2 app is public.", "default": "", - "x-example": "s256" + "example": "s256" }, "prompt": { "type": "string", "description": "OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.", "default": "", - "x-example": "<PROMPT>" + "example": "<PROMPT>" }, "max_age": { "type": "integer", "description": "OIDC max_age paraleter for customization of consent screen. Maximum allowable elapsed time in seconds since the user last authenticated. If exceeded, re-authentication is required.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "authorization_details": { "type": "string", "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "<AUDIENCE>" + "example": "<AUDIENCE>" }, "request_uri": { "type": "string", "description": "OAuth2 authorization request handle returned by the pushed authorization request endpoint.", "default": "", - "x-example": "<REQUEST_URI>" + "example": "<REQUEST_URI>" } } } @@ -36120,7 +36109,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -36135,31 +36124,30 @@ "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "scope": { "type": "string", "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`.", "default": "", - "x-example": "<SCOPE>" + "example": "<SCOPE>" }, "authorization_details": { "type": "string", "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "<AUDIENCE>" + "example": "<AUDIENCE>" } } } @@ -36224,7 +36212,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -36238,7 +36226,7 @@ "user_code": { "type": "string", "description": "User code displayed on the device.", - "x-example": "<USER_CODE>" + "example": "<USER_CODE>" } }, "required": [ @@ -36307,7 +36295,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -36317,7 +36305,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<GRANT_ID>" + "example": "<GRANT_ID>" }, "in": "path" } @@ -36381,7 +36369,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -36392,7 +36380,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -36404,7 +36392,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -36415,7 +36403,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -36480,7 +36468,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -36494,79 +36482,78 @@ "client_id": { "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "redirect_uri": { "type": "string", "description": "Redirect URI where visitor will be redirected after authorization, whether successful or not.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "response_type": { "type": "string", "description": "OAuth2 \/ OIDC response type.", - "x-example": "code" + "example": "code" }, "scope": { "type": "string", "description": "Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`, `phone`.", "default": "", - "x-example": "<SCOPE>" + "example": "<SCOPE>" }, "state": { "type": "string", "description": "OAuth2 state. You receive this back in the redirect URI.", "default": "", - "x-example": "<STATE>" + "example": "<STATE>" }, "nonce": { "type": "string", "description": "OIDC nonce parameter to prevent replay attacks. Required when response_type includes `id_token`.", "default": "", - "x-example": "<NONCE>" + "example": "<NONCE>" }, "code_challenge": { "type": "string", "description": "PKCE code challenge. Required when OAuth2 app is public.", "default": "", - "x-example": "<CODE_CHALLENGE>" + "example": "<CODE_CHALLENGE>" }, "code_challenge_method": { "type": "string", "description": "PKCE code challenge method. Required when OAuth2 app is public.", "default": "", - "x-example": "s256" + "example": "s256" }, "prompt": { "type": "string", "description": "OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.", "default": "", - "x-example": "<PROMPT>" + "example": "<PROMPT>" }, "max_age": { "type": "integer", "description": "OIDC max_age parameter for customization of consent screen.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "authorization_details": { "type": "string", "description": "Rich authorization request. JSON array of objects, each with a `type` and project-defined fields", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "<AUDIENCE>" + "example": "<AUDIENCE>" } }, "required": [ @@ -36637,7 +36624,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" }, @@ -36648,7 +36635,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -36660,7 +36647,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -36671,7 +36658,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -36735,7 +36722,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -36749,7 +36736,7 @@ "grant_id": { "type": "string", "description": "Grant ID made during authorization, provided to consent screen in URL search params.", - "x-example": "<GRANT_ID>" + "example": "<GRANT_ID>" } }, "required": [ @@ -36819,7 +36806,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -36833,25 +36820,25 @@ "token": { "type": "string", "description": "The access or refresh token to revoke.", - "x-example": "<TOKEN>" + "example": "<TOKEN>" }, "token_type_hint": { "type": "string", "description": "Type of token to revoke (access_token or refresh_token).", "default": "", - "x-example": "access_token" + "example": "access_token" }, "client_id": { "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "client_secret": { "type": "string", "description": "OAuth2 client secret. Required for confidential apps; omitted for public apps.", "default": "", - "x-example": "<CLIENT_SECRET>" + "example": "<CLIENT_SECRET>" } }, "required": [ @@ -36920,7 +36907,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -36934,62 +36921,61 @@ "grant_type": { "type": "string", "description": "OAuth2 grant type. Can be one of: `authorization_code`, `refresh_token`, `urn:ietf:params:oauth:grant-type:device_code`.", - "x-example": "<GRANT_TYPE>" + "example": "<GRANT_TYPE>" }, "code": { "type": "string", "description": "Authorization code to be exchanged for access and refresh tokens. Required for `authorization_code` grant type.", "default": "", - "x-example": "<CODE>" + "example": "<CODE>" }, "refresh_token": { "type": "string", "description": "Refresh token to be exchanged for a new access and refresh tokens. Required for `refresh_token` grant type.", "default": "", - "x-example": "<REFRESH_TOKEN>" + "example": "<REFRESH_TOKEN>" }, "device_code": { "type": "string", "description": "Device code obtained from the device authorization endpoint. Required for `urn:ietf:params:oauth:grant-type:device_code` grant type.", "default": "", - "x-example": "<DEVICE_CODE>" + "example": "<DEVICE_CODE>" }, "client_id": { "type": "string", "description": "OAuth2 client ID. Either a registered app ID or an HTTPS client ID metadata document URL.", "default": "", - "x-example": "<CLIENT_ID>" + "example": "<CLIENT_ID>" }, "client_secret": { "type": "string", "description": "OAuth2 client secret. Required for confidential apps.", "default": "", - "x-example": "<CLIENT_SECRET>" + "example": "<CLIENT_SECRET>" }, "code_verifier": { "type": "string", "description": "PKCE code verifier. Required for public apps.", "default": "", - "x-example": "<CODE_VERIFIER>" + "example": "<CODE_VERIFIER>" }, "redirect_uri": { "type": "string", "description": "Redirect URI. Required for `authorization_code` grant type.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "resource": { "type": "string", "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "default": [], - "x-example": null + "default": [] }, "audience": { "type": "string", "description": "Compatibility alias for a single OAuth2 resource indicator URI.", "default": "", - "x-example": "<AUDIENCE>" + "example": "<AUDIENCE>" } }, "required": [ @@ -37106,7 +37092,7 @@ "name": { "type": "string", "description": "New organization name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -37230,7 +37216,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -37296,13 +37282,13 @@ "appId": { "type": "string", "description": "Application unique ID.", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" } }, "required": [ @@ -37372,7 +37358,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -37435,7 +37421,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -37449,8 +37435,8 @@ "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.", - "x-example": "<AUTHORIZATION_DETAILS>", - "x-nullable": true + "example": "<AUTHORIZATION_DETAILS>", + "nullable": true } } } @@ -37511,7 +37497,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -37586,7 +37572,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -37649,7 +37635,7 @@ "keyId": { "type": "string", "description": "Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<KEY_ID>", + "example": "<KEY_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -37657,12 +37643,11 @@ "name": { "type": "string", "description": "Key name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -37707,9 +37692,9 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -37778,7 +37763,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -37838,7 +37823,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -37852,12 +37837,11 @@ "name": { "type": "string", "description": "Key name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -37902,9 +37886,9 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -37963,7 +37947,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -38038,7 +38022,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -38049,7 +38033,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -38113,26 +38097,25 @@ "type": "string", "description": "Email of the new organization member.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "userId": { "type": "string", "description": "ID of the user to be added to the organization.", "default": "", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "roles": { "type": "array", "description": "Array of strings. Use this param to set the user roles in the organization. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", - "x-example": null, "items": { "type": "string" } @@ -38141,14 +38124,14 @@ "type": "string", "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "name": { "type": "string", "description": "Name of the new organization member. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -38215,7 +38198,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -38275,7 +38258,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -38289,7 +38272,6 @@ "roles": { "type": "array", "description": "An array of strings. Use this param to set the user's roles in the organization. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", - "x-example": null, "items": { "type": "string" } @@ -38350,7 +38332,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -38425,7 +38407,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -38436,7 +38418,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -38498,18 +38480,17 @@ "properties": { "projectId": { "type": "string", - "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.", - "x-example": null + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars." }, "name": { "type": "string", "description": "Project name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "region": { "type": "string", "description": "Project Region.", - "x-example": "fra", + "example": "fra", "enum": [ "fra", "nyc", @@ -38594,7 +38575,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -38654,7 +38635,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -38668,7 +38649,7 @@ "name": { "type": "string", "description": "Project name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -38726,7 +38707,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PROJECT_ID>" + "example": "<PROJECT_ID>" }, "in": "path" } @@ -38903,7 +38884,7 @@ "databaseId": { "type": "string", "description": "Database ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -38911,87 +38892,86 @@ "name": { "type": "string", "description": "Database display name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "version": { "type": "string", "description": "Database engine version. Defaults to latest for selected engine.", - "x-example": "17", - "x-nullable": true + "example": "17", + "nullable": true }, "specification": { "type": "string", "description": "Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.", "default": "s-1vcpu-1gb", - "x-example": "<SPECIFICATION>" + "example": "<SPECIFICATION>" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds.", "default": 900, - "x-example": 60, + "example": 60, "format": "int32" }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes of inactivity before container scales to zero.", "default": 15, - "x-example": 5, + "example": 5, "format": "int32" }, "pitr": { "type": "boolean", "description": "Enable point-in-time recovery (PITR). Continuously archives changes so the database can be restored to any moment within the retention window.", "default": true, - "x-example": false + "example": false }, "pitrRetentionDays": { "type": "integer", "description": "Number of days to retain PITR data.", "default": 7, - "x-example": 1, + "example": 1, "format": "int32" }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", "default": false, - "x-example": false + "example": false }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", "default": 85, - "x-example": 50, + "example": 50, "format": "int32" }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -39108,7 +39088,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -39167,7 +39147,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -39181,139 +39161,136 @@ "name": { "type": "string", "description": "Database display name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "status": { "type": "string", "description": "Database status. Allowed values: ready, paused, inactive. Set to \"paused\" to pause, \"ready\" to resume (also recovers a failed database whose infrastructure is healthy), or \"inactive\" to spin down a shared-pool database.", - "x-example": "ready", - "x-nullable": true + "example": "ready", + "nullable": true }, "specification": { "type": "string", "description": "Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5). High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode preference. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds (60-86400).", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "networkIPAllowlist": { "type": "array", "description": "IP addresses\/CIDR ranges allowed to connect.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes before container scales to zero.", - "x-example": 5, + "example": 5, "format": "int32", - "x-nullable": true + "nullable": true }, "pitr": { "type": "boolean", "description": "Enable or disable point-in-time recovery (PITR).", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "pitrRetentionDays": { "type": "integer", "description": "Days to retain PITR data.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscaling": { "type": "boolean", "description": "Enable automatic storage expansion when usage exceeds threshold.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage (50-95) that triggers automatic expansion.", - "x-example": 50, + "example": 50, "format": "int32", - "x-nullable": true + "nullable": true }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "metricsTraceSampleRate": { "type": "number", "description": "Fraction of queries to trace (0.0\u20131.0). Forwarded to the sidecar.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "metricsSlowQueryLogThresholdMs": { "type": "integer", "description": "Threshold in ms above which queries are logged as slow. Forwarded to the sidecar.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiEnabled": { "type": "boolean", "description": "Enable the SQL API sidecar for this database.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "sqlApiAllowedStatements": { "type": "array", "description": "Statement types the SQL API accepts. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "sqlApiMaxRows": { "type": "integer", "description": "Maximum rows returned per SQL API execution (1-1000000).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiMaxBytes": { "type": "integer", "description": "Maximum serialised SQL API result payload in bytes (1024-104857600).", - "x-example": 1024, + "example": 1024, "format": "int32", - "x-nullable": true + "nullable": true }, "sqlApiTimeoutSeconds": { "type": "integer", "description": "Per-call SQL API execution timeout in seconds (1-300).", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } } } @@ -39370,7 +39347,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -39431,7 +39408,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -39503,7 +39480,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -39518,7 +39495,7 @@ "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" } } } @@ -39581,7 +39558,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -39653,7 +39630,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -39667,7 +39644,7 @@ "policyId": { "type": "string", "description": "Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<POLICY_ID>", + "example": "<POLICY_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -39675,30 +39652,29 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32" }, "type": { "type": "string", "description": "Backup type: full or incremental.", "default": "full", - "x-example": "full" + "example": "full" }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -39767,7 +39743,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -39777,7 +39753,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -39836,7 +39812,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -39846,7 +39822,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -39860,26 +39836,25 @@ "name": { "type": "string", "description": "Policy name. Max length: 128 chars.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "schedule": { "type": "string", - "description": "Schedule CRON syntax.", - "x-example": null + "description": "Schedule CRON syntax." }, "retention": { "type": "integer", "description": "Days to keep backups before deletion.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Is policy enabled? When disabled, no backups will be taken.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -39936,7 +39911,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -39946,7 +39921,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<POLICY_ID>" + "example": "<POLICY_ID>" }, "in": "path" } @@ -40007,7 +39982,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -40021,40 +39996,40 @@ "provider": { "type": "string", "description": "Storage provider for off-cluster backups. Allowed values: s3 (Amazon S3 or S3-compatible), gcs (Google Cloud Storage), azure (Azure Blob Storage).", - "x-example": "s3" + "example": "s3" }, "bucket": { "type": "string", "description": "Storage bucket or container name.", - "x-example": "<BUCKET>" + "example": "<BUCKET>" }, "region": { "type": "string", "description": "Storage region.", "default": "", - "x-example": "<REGION>" + "example": "<REGION>" }, "prefix": { "type": "string", "description": "Object key prefix for backups.", "default": "backups\/", - "x-example": "<PREFIX>" + "example": "<PREFIX>" }, "endpoint": { "type": "string", "description": "Custom endpoint for S3-compatible storage (e.g. MinIO).", "default": "", - "x-example": "<ENDPOINT>" + "example": "<ENDPOINT>" }, "accessKey": { "type": "string", "description": "Access key or client ID for authentication.", - "x-example": "<ACCESS_KEY>" + "example": "<ACCESS_KEY>" }, "secretKey": { "type": "string", "description": "Secret key or service account JSON for authentication.", - "x-example": "<SECRET_KEY>" + "example": "<SECRET_KEY>" } }, "required": [ @@ -40123,7 +40098,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -40133,7 +40108,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -40188,7 +40163,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -40198,7 +40173,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BACKUP_ID>" + "example": "<BACKUP_ID>" }, "in": "path" } @@ -40259,7 +40234,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -40318,7 +40293,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -40333,7 +40308,7 @@ "type": "string", "description": "Branch ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", "default": "", - "x-example": "<BRANCH_ID>", + "example": "<BRANCH_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -40342,7 +40317,7 @@ "type": "integer", "description": "Time-to-live in seconds before the branch expires. Min 300 (5 min), max 604800 (7 days). Default: 86400 (24h).", "default": 86400, - "x-example": 300, + "example": 300, "format": "int32" } } @@ -40406,7 +40381,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -40416,7 +40391,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BRANCH_ID>" + "example": "<BRANCH_ID>" }, "in": "path" } @@ -40477,7 +40452,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -40538,7 +40513,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -40552,21 +40527,21 @@ "sql": { "type": "string", "description": "SQL statement to execute. Exactly one statement per request.", - "x-example": "<SQL>" + "example": "<SQL>" }, "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 + "example": {}, + "nullable": true }, "timeoutSeconds": { "type": "integer", "description": "Per-call execution timeout override. Must be less than or equal to the database's configured sqlApiTimeoutSeconds.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } }, "required": [ @@ -40632,7 +40607,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -40691,7 +40666,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -40705,7 +40680,7 @@ "name": { "type": "string", "description": "Extension name (e.g., pgvector, postgis, uuid-ossp).", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -40771,7 +40746,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -40781,7 +40756,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<EXTENSION_NAME>" + "example": "<EXTENSION_NAME>" }, "in": "path" } @@ -40842,7 +40817,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -40856,8 +40831,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -40920,7 +40895,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -40934,12 +40909,12 @@ "day": { "type": "string", "description": "Day of the week for the maintenance window. Allowed values: sun, mon, tue, wed, thu, fri, sat.", - "x-example": "sun" + "example": "sun" }, "hourUtc": { "type": "integer", "description": "Hour in UTC (0-23) for maintenance window start.", - "x-example": 0, + "example": 0, "format": "int32" } }, @@ -41007,7 +40982,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41021,13 +40996,13 @@ "targetType": { "type": "string", "description": "Target database type to migrate to. Allowed values: shared (serverless, scales to zero when idle), dedicated (always-on with persistent resources).", - "x-example": "shared" + "example": "shared" }, "specification": { "type": "string", "description": "Target specification to provision when migrating to dedicated. Ignored for shared. Defaults to the database's current specification.", - "x-example": "<SPECIFICATION>", - "x-nullable": true + "example": "<SPECIFICATION>", + "nullable": true } }, "required": [ @@ -41093,7 +41068,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -41103,7 +41078,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -41114,7 +41089,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -41126,7 +41101,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -41188,7 +41163,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41249,7 +41224,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41308,7 +41283,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41322,52 +41297,52 @@ "mode": { "type": "string", "description": "Connection pool mode. Allowed values: transaction, session. Transaction mode returns connections to the pool after each transaction; session mode holds connections for the entire session lifetime.", - "x-example": "transaction", - "x-nullable": true + "example": "transaction", + "nullable": true }, "maxConnections": { "type": "integer", "description": "Client-connection ceiling the pooler accepts. Supported on MySQL and MariaDB only; the PostgreSQL pooler has no client cap, so set networkMaxConnections on the database instead.", - "x-example": 10, + "example": 10, "format": "int32", - "x-nullable": true + "nullable": true }, "defaultPoolSize": { "type": "integer", "description": "Default pool size per user.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "readWriteSplitting": { "type": "boolean", "description": "Route SELECTs to HA replicas, writes and locked reads to the primary. Defaults to true when HA is enabled.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "poolerCpuRequest": { "type": "string", "description": "Pooler sidecar CPU request override (Kubernetes quantity, e.g. \"250m\" or \"1\"). Leave null for the proportional default (5% of DB CPU, floor 100m).", - "x-example": "<POOLER_CPU_REQUEST>", - "x-nullable": true + "example": "<POOLER_CPU_REQUEST>", + "nullable": true }, "poolerCpuLimit": { "type": "string", "description": "Pooler sidecar CPU limit override (Kubernetes quantity, e.g. \"500m\" or \"1\"). Leave null for the proportional default (10% of DB CPU, floor 200m). Changing this field rolls the database pod.", - "x-example": "<POOLER_CPU_LIMIT>", - "x-nullable": true + "example": "<POOLER_CPU_LIMIT>", + "nullable": true }, "poolerMemoryRequest": { "type": "string", "description": "Pooler sidecar memory request override (Kubernetes quantity, e.g. \"128Mi\" or \"1Gi\"). Leave null for the proportional default (7.5% of DB memory, floor 64Mi).", - "x-example": "<POOLER_MEMORY_REQUEST>", - "x-nullable": true + "example": "<POOLER_MEMORY_REQUEST>", + "nullable": true }, "poolerMemoryLimit": { "type": "string", "description": "Pooler sidecar memory limit override (Kubernetes quantity, e.g. \"256Mi\" or \"1Gi\"). Leave null for the proportional default (15% of DB memory, floor 128Mi). Changing this field rolls the database pod.", - "x-example": "<POOLER_MEMORY_LIMIT>", - "x-nullable": true + "example": "<POOLER_MEMORY_LIMIT>", + "nullable": true } } } @@ -41430,7 +41405,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41491,7 +41466,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -41501,7 +41476,7 @@ "required": false, "schema": { "type": "string", - "x-example": "pending" + "example": "pending" }, "in": "query" }, @@ -41511,7 +41486,7 @@ "required": false, "schema": { "type": "string", - "x-example": "backup" + "example": "backup" }, "in": "query" }, @@ -41522,7 +41497,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -41534,7 +41509,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -41594,7 +41569,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41609,26 +41584,26 @@ "type": "string", "description": "Restoration type. Allowed values: backup, pitr. Use \"backup\" to restore from a specific backup, or \"pitr\" for point-in-time recovery.", "default": "backup", - "x-example": "backup" + "example": "backup" }, "backupId": { "type": "string", "description": "Backup ID to restore from (required for backup type).", - "x-example": "<BACKUP_ID>", - "x-nullable": true + "example": "<BACKUP_ID>", + "nullable": true }, "targetDatabaseId": { "type": "string", "description": "Existing database ID to restore into. The target must be distinct, ready, and use the same engine and version.", - "x-example": "<TARGET_DATABASE_ID>", - "x-nullable": true + "example": "<TARGET_DATABASE_ID>", + "nullable": true }, "targetTime": { "type": "string", "description": "Target time for PITR (required for pitr type) as an [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -41691,7 +41666,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -41701,7 +41676,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RESTORATION_ID>" + "example": "<RESTORATION_ID>" }, "in": "path" } @@ -41762,7 +41737,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41823,7 +41798,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -41837,7 +41812,7 @@ "targetVersion": { "type": "string", "description": "Target engine version to upgrade to.", - "x-example": "<TARGET_VERSION>" + "example": "<TARGET_VERSION>" } }, "required": [ @@ -41920,7 +41895,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -41932,7 +41907,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -41998,7 +41973,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PRESENCE_ID>" + "example": "<PRESENCE_ID>" }, "in": "path" } @@ -42091,7 +42066,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PRESENCE_ID>" + "example": "<PRESENCE_ID>" }, "in": "path" } @@ -42105,17 +42080,19 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "status": { "type": "string", "description": "Presence status.", - "x-example": "<STATUS>" + "example": "<STATUS>" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -42123,14 +42100,14 @@ "expiresAt": { "type": "string", "description": "Presence expiry datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime" }, "metadata": { "type": "object", "description": "Presence metadata object.", "default": [], - "x-example": "{}" + "example": {} } }, "required": [ @@ -42228,7 +42205,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PRESENCE_ID>" + "example": "<PRESENCE_ID>" }, "in": "path" } @@ -42242,29 +42219,31 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "status": { "type": "string", "description": "Presence status.", - "x-example": "<STATUS>" + "example": "<STATUS>" }, "expiresAt": { "type": "string", "description": "Presence expiry datetime.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime" }, "metadata": { "type": "object", "description": "Presence metadata object.", "default": {}, - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -42273,7 +42252,7 @@ "type": "boolean", "description": "When true, purge cached responses used by list presences endpoint.", "default": false, - "x-example": false + "example": false } } } @@ -42331,7 +42310,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PRESENCE_ID>" + "example": "<PRESENCE_ID>" }, "in": "path" } @@ -42481,7 +42460,7 @@ "required": true, "schema": { "type": "string", - "x-example": "email-password", + "example": "email-password", "enum": [ "email-password", "magic-url", @@ -42514,7 +42493,7 @@ "enabled": { "type": "boolean", "description": "Auth method status.", - "x-example": false + "example": false } }, "required": [ @@ -42593,7 +42572,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -42657,7 +42636,6 @@ "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -42880,7 +42858,7 @@ "duration": { "type": "integer", "description": "Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.", - "x-example": "600", + "example": 600, "format": "int32" } }, @@ -42948,7 +42926,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -43007,7 +42985,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -43021,12 +42999,11 @@ "name": { "type": "string", "description": "Key name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "scopes": { "type": "array", "description": "Key scopes list. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -43249,9 +43226,9 @@ "expire": { "type": "string", "description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } }, "required": [ @@ -43309,7 +43286,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<KEY_ID>" + "example": "<KEY_ID>" }, "in": "path" } @@ -43372,7 +43349,6 @@ "labels": { "type": "array", "description": "Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", - "x-example": null, "items": { "type": "string" } @@ -43454,7 +43430,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -43516,13 +43492,13 @@ "number": { "type": "string", "description": "Phone number to associate with the mock phone. Must be a valid E.164 formatted phone number.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "otp": { "type": "string", "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", - "x-example": "<OTP>" + "example": "<OTP>" } }, "required": [ @@ -43590,7 +43566,7 @@ "schema": { "type": "string", "format": "phone", - "x-example": "+12065550100" + "example": "+12065550100" }, "in": "path" } @@ -43650,7 +43626,7 @@ "schema": { "type": "string", "format": "phone", - "x-example": "+12065550100" + "example": "+12065550100" }, "in": "path" } @@ -43664,7 +43640,7 @@ "otp": { "type": "string", "description": "One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.", - "x-example": "<OTP>" + "example": "<OTP>" } }, "required": [ @@ -43722,7 +43698,7 @@ "schema": { "type": "string", "format": "phone", - "x-example": "+12065550100" + "example": "+12065550100" }, "in": "path" } @@ -43796,7 +43772,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -43860,19 +43836,18 @@ "enabled": { "type": "boolean", "description": "Enable or disable the OAuth2 server.", - "x-example": false + "example": false }, "authorizationUrl": { "type": "string", "description": "URL to your application with consent screen.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "scopes": { "type": "array", "description": "List of allowed OAuth2 scopes. Maximum of 100 scopes are allowed, each up to 128 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -43881,7 +43856,6 @@ "type": "array", "description": "List of accepted `authorization_details` types. Maximum of 100 types are allowed, each up to 128 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -43889,76 +43863,75 @@ "accessTokenDuration": { "type": "integer", "description": "Access token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 8 hours.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "refreshTokenDuration": { "type": "integer", "description": "Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "publicAccessTokenDuration": { "type": "integer", "description": "Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "publicRefreshTokenDuration": { "type": "integer", "description": "Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "installationAccessTokenDuration": { "type": "integer", "description": "Access token duration in seconds for app installation access tokens. Leave empty to use default 1 hour.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "confidentialPkce": { "type": "boolean", "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "verificationUrl": { "type": "string", "description": "URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "userCodeLength": { "type": "integer", "description": "Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.", - "x-example": 6, + "example": 6, "format": "int32", - "x-nullable": true + "nullable": true }, "userCodeFormat": { "type": "string", "description": "Character set for device flow user codes: `numeric` (digits only \u2014 best for numeric keypads and TV remotes), `alphabetic` (letters only), or `alphanumeric` (letters and digits \u2014 highest entropy per character). Defaults to `alphanumeric`.", "default": "alphanumeric", - "x-example": "numeric" + "example": "numeric" }, "deviceCodeDuration": { "type": "integer", "description": "Lifetime in seconds of device flow device codes and user codes. Device codes are intentionally short-lived. Leave empty to use default 600.", - "x-example": 60, + "example": 60, "format": "int32", - "x-nullable": true + "nullable": true }, "defaultScopes": { "type": "array", "description": "List of OAuth2 scopes used when an authorization request omits the scope parameter. Every default scope must also be allowed by the OAuth2 server. Maximum of 100 scopes are allowed, each up to 128 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -43967,7 +43940,6 @@ "type": "array", "description": "List of scopes an application may request when installed on a team. Omitting the parameter clears the list, so no installation scopes can be granted. Maximum of 100 scopes are allowed, each up to 128 characters long.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -44039,20 +44011,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44117,32 +44089,32 @@ "serviceId": { "type": "string", "description": "'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web", - "x-example": "<SERVICE_ID>", - "x-nullable": true + "example": "<SERVICE_ID>", + "nullable": true }, "keyId": { "type": "string", "description": "'Key ID' of Apple OAuth2 app. For example: P4000000N8", - "x-example": "<KEY_ID>", - "x-nullable": true + "example": "<KEY_ID>", + "nullable": true }, "teamId": { "type": "string", "description": "'Team ID' of Apple OAuth2 app. For example: D4000000R6", - "x-example": "<TEAM_ID>", - "x-nullable": true + "example": "<TEAM_ID>", + "nullable": true }, "p8File": { "type": "string", "description": "Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----", - "x-example": "<P8_FILE>", - "x-nullable": true + "example": "<P8_FILE>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44207,20 +44179,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Appwrite OAuth2 app. For example: 6a42000000000000b5a0", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Appwrite OAuth2 app. For example: b86afd000000000000000000000000000000000000000000000000000ced5f93", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44285,26 +44257,26 @@ "clientId": { "type": "string", "description": "'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "endpoint": { "type": "string", "description": "Domain of Auth0 instance. For example: example.us.auth0.com", - "x-example": "<ENDPOINT>", - "x-nullable": true + "example": "<ENDPOINT>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44369,26 +44341,26 @@ "clientId": { "type": "string", "description": "'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "endpoint": { "type": "string", "description": "Domain of Authentik instance. For example: example.authentik.com", - "x-example": "<ENDPOINT>", - "x-nullable": true + "example": "<ENDPOINT>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44453,20 +44425,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44531,20 +44503,20 @@ "key": { "type": "string", "description": "'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc", - "x-example": "<KEY>", - "x-nullable": true + "example": "<KEY>", + "nullable": true }, "secret": { "type": "string", "description": "'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx", - "x-example": "<SECRET>", - "x-nullable": true + "example": "<SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44609,20 +44581,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44687,20 +44659,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44765,20 +44737,20 @@ "apiKey": { "type": "string", "description": "'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f", - "x-example": "<API_KEY>", - "x-nullable": true + "example": "<API_KEY>", + "nullable": true }, "apiSecret": { "type": "string", "description": "'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639", - "x-example": "<API_SECRET>", - "x-nullable": true + "example": "<API_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44843,20 +44815,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Discord OAuth2 app. For example: 950722000000343754", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44921,20 +44893,20 @@ "publicKey": { "type": "string", "description": "'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", - "x-example": "<PUBLIC_KEY>", - "x-nullable": true + "example": "<PUBLIC_KEY>", + "nullable": true }, "secretKey": { "type": "string", "description": "'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9", - "x-example": "<SECRET_KEY>", - "x-nullable": true + "example": "<SECRET_KEY>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -44999,20 +44971,20 @@ "appKey": { "type": "string", "description": "'App Key' of Dropbox OAuth2 app. For example: jl000000000009t", - "x-example": "<APP_KEY>", - "x-nullable": true + "example": "<APP_KEY>", + "nullable": true }, "appSecret": { "type": "string", "description": "'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw", - "x-example": "<APP_SECRET>", - "x-nullable": true + "example": "<APP_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45077,20 +45049,20 @@ "keyString": { "type": "string", "description": "'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2", - "x-example": "<KEY_STRING>", - "x-nullable": true + "example": "<KEY_STRING>", + "nullable": true }, "sharedSecret": { "type": "string", "description": "'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru", - "x-example": "<SHARED_SECRET>", - "x-nullable": true + "example": "<SHARED_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45155,20 +45127,20 @@ "appId": { "type": "string", "description": "'App ID' of Facebook OAuth2 app. For example: 260600000007694", - "x-example": "<APP_ID>", - "x-nullable": true + "example": "<APP_ID>", + "nullable": true }, "appSecret": { "type": "string", "description": "'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4", - "x-example": "<APP_SECRET>", - "x-nullable": true + "example": "<APP_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45233,20 +45205,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45311,26 +45283,26 @@ "clientId": { "type": "string", "description": "'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "endpoint": { "type": "string", "description": "Domain of FusionAuth instance. For example: example.fusionauth.io", - "x-example": "<ENDPOINT>", - "x-nullable": true + "example": "<ENDPOINT>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45395,20 +45367,20 @@ "clientId": { "type": "string", "description": "'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45473,27 +45445,27 @@ "applicationId": { "type": "string", "description": "'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252", - "x-example": "<APPLICATION_ID>", - "x-nullable": true + "example": "<APPLICATION_ID>", + "nullable": true }, "secret": { "type": "string", "description": "'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", - "x-example": "<SECRET>", - "x-nullable": true + "example": "<SECRET>", + "nullable": true }, "endpoint": { "type": "string", "description": "Endpoint URL of self-hosted GitLab instance. For example: https:\/\/gitlab.com", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45558,19 +45530,18 @@ "clientId": { "type": "string", "description": "'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "prompt": { "type": "array", "description": "Array of Google OAuth2 prompt values. If \"none\" is included, it must be the only element. \"none\" means: don't display any authentication or consent screens. Must not be specified with other values. \"consent\" means: prompt the user for consent. \"select_account\" means: prompt the user to select an account.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -45585,13 +45556,13 @@ "select_account" ] }, - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45656,32 +45627,32 @@ "clientId": { "type": "string", "description": "'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "endpoint": { "type": "string", "description": "Domain of Keycloak instance. For example: keycloak.example.com", - "x-example": "<ENDPOINT>", - "x-nullable": true + "example": "<ENDPOINT>", + "nullable": true }, "realmName": { "type": "string", "description": "Keycloak realm name. For example: appwrite-realm", - "x-example": "<REALM_NAME>", - "x-nullable": true + "example": "<REALM_NAME>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45746,20 +45717,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45824,20 +45795,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "primaryClientSecret": { "type": "string", "description": "'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000.\/HtlYw==", - "x-example": "<PRIMARY_CLIENT_SECRET>", - "x-nullable": true + "example": "<PRIMARY_CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45902,26 +45873,26 @@ "applicationId": { "type": "string", "description": "'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444", - "x-example": "<APPLICATION_ID>", - "x-nullable": true + "example": "<APPLICATION_ID>", + "nullable": true }, "applicationSecret": { "type": "string", "description": "'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", - "x-example": "<APPLICATION_SECRET>", - "x-nullable": true + "example": "<APPLICATION_SECRET>", + "nullable": true }, "tenant": { "type": "string", "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common", - "x-example": "<TENANT>", - "x-nullable": true + "example": "<TENANT>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -45986,20 +45957,20 @@ "oauthClientId": { "type": "string", "description": "'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3", - "x-example": "<OAUTH_CLIENT_ID>", - "x-nullable": true + "example": "<OAUTH_CLIENT_ID>", + "nullable": true }, "oauthClientSecret": { "type": "string", "description": "'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9", - "x-example": "<OAUTH_CLIENT_SECRET>", - "x-nullable": true + "example": "<OAUTH_CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46064,47 +46035,46 @@ "clientId": { "type": "string", "description": "'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "wellKnownURL": { "type": "string", "description": "OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https:\/\/myoauth.com\/.well-known\/openid-configuration", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "authorizationURL": { "type": "string", "description": "OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/authorize", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/token", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https:\/\/myoauth.com\/oauth2\/userinfo", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "prompt": { "type": "array", "description": "Array of OpenID Connect prompt values controlling the authentication and consent screens. If \"none\" is included, it must be the only element. \"none\" means: don't display any authentication or consent screens. \"login\" means: prompt the user to re-authenticate. \"consent\" means: prompt the user for consent. \"select_account\" means: prompt the user to select an account.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -46121,20 +46091,20 @@ "select_account" ] }, - "x-nullable": true + "nullable": true }, "maxAge": { "type": "integer", "description": "Maximum authentication age in seconds. When set, the user must have authenticated within this many seconds, otherwise they are prompted to re-authenticate.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46199,32 +46169,31 @@ "clientId": { "type": "string", "description": "'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "domain": { "type": "string", "description": "Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https:\/\/trial-6400025.okta.com\/", - "x-example": null, - "x-nullable": true + "nullable": true }, "authorizationServerId": { "type": "string", "description": "Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z", - "x-example": "<AUTHORIZATION_SERVER_ID>", - "x-nullable": true + "example": "<AUTHORIZATION_SERVER_ID>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46289,20 +46258,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "secretKey": { "type": "string", "description": "'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", - "x-example": "<SECRET_KEY>", - "x-nullable": true + "example": "<SECRET_KEY>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46367,20 +46336,20 @@ "clientId": { "type": "string", "description": "'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "secretKey": { "type": "string", "description": "'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", - "x-example": "<SECRET_KEY>", - "x-nullable": true + "example": "<SECRET_KEY>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46445,20 +46414,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46523,20 +46492,20 @@ "customerKey": { "type": "string", "description": "'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", - "x-example": "<CUSTOMER_KEY>", - "x-nullable": true + "example": "<CUSTOMER_KEY>", + "nullable": true }, "customerSecret": { "type": "string", "description": "'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2", - "x-example": "<CUSTOMER_SECRET>", - "x-nullable": true + "example": "<CUSTOMER_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46601,20 +46570,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46679,20 +46648,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46757,20 +46726,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "apiSecretKey": { "type": "string", "description": "'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp", - "x-example": "<API_SECRET_KEY>", - "x-nullable": true + "example": "<API_SECRET_KEY>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46835,20 +46804,20 @@ "oauth2ClientId": { "type": "string", "description": "'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app", - "x-example": "<OAUTH2_CLIENT_ID>", - "x-nullable": true + "example": "<OAUTH2_CLIENT_ID>", + "nullable": true }, "oauth2ClientSecret": { "type": "string", "description": "'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", - "x-example": "<OAUTH2_CLIENT_SECRET>", - "x-nullable": true + "example": "<OAUTH2_CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46913,20 +46882,20 @@ "oauth2ClientId": { "type": "string", "description": "'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app", - "x-example": "<OAUTH2_CLIENT_ID>", - "x-nullable": true + "example": "<OAUTH2_CLIENT_ID>", + "nullable": true }, "oauth2ClientSecret": { "type": "string", "description": "'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83", - "x-example": "<OAUTH2_CLIENT_SECRET>", - "x-nullable": true + "example": "<OAUTH2_CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -46991,20 +46960,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -47069,20 +47038,20 @@ "clientId": { "type": "string", "description": "'Client ID' of WordPress OAuth2 app. For example: 130005", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -47147,20 +47116,20 @@ "customerKey": { "type": "string", "description": "'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT", - "x-example": "<CUSTOMER_KEY>", - "x-nullable": true + "example": "<CUSTOMER_KEY>", + "nullable": true }, "secretKey": { "type": "string", "description": "'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9", - "x-example": "<SECRET_KEY>", - "x-nullable": true + "example": "<SECRET_KEY>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -47225,20 +47194,20 @@ "clientId": { "type": "string", "description": "'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -47303,20 +47272,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -47381,20 +47350,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -47459,20 +47428,20 @@ "clientId": { "type": "string", "description": "'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ", - "x-example": "<CLIENT_ID>", - "x-nullable": true + "example": "<CLIENT_ID>", + "nullable": true }, "clientSecret": { "type": "string", "description": "'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON", - "x-example": "<CLIENT_SECRET>", - "x-nullable": true + "example": "<CLIENT_SECRET>", + "nullable": true }, "enabled": { "type": "boolean", "description": "OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -47703,7 +47672,7 @@ "required": true, "schema": { "type": "string", - "x-example": "amazon", + "example": "amazon", "enum": [ "amazon", "apple", @@ -47870,7 +47839,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -47934,7 +47903,7 @@ "platformId": { "type": "string", "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PLATFORM_ID>", + "example": "<PLATFORM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -47942,12 +47911,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "applicationId": { "type": "string", "description": "Android application ID. Max length: 256 chars.", - "x-example": "<APPLICATION_ID>" + "example": "<APPLICATION_ID>" } }, "required": [ @@ -48015,7 +47984,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -48029,12 +47998,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "applicationId": { "type": "string", "description": "Android application ID. Max length: 256 chars.", - "x-example": "<APPLICATION_ID>" + "example": "<APPLICATION_ID>" } }, "required": [ @@ -48103,7 +48072,7 @@ "platformId": { "type": "string", "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PLATFORM_ID>", + "example": "<PLATFORM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -48111,12 +48080,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "bundleIdentifier": { "type": "string", "description": "Apple bundle identifier. Max length: 256 chars.", - "x-example": "<BUNDLE_IDENTIFIER>" + "example": "<BUNDLE_IDENTIFIER>" } }, "required": [ @@ -48184,7 +48153,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -48198,12 +48167,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "bundleIdentifier": { "type": "string", "description": "Apple bundle identifier. Max length: 256 chars.", - "x-example": "<BUNDLE_IDENTIFIER>" + "example": "<BUNDLE_IDENTIFIER>" } }, "required": [ @@ -48272,7 +48241,7 @@ "platformId": { "type": "string", "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PLATFORM_ID>", + "example": "<PLATFORM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -48280,12 +48249,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "packageName": { "type": "string", "description": "Linux package name. Max length: 256 chars.", - "x-example": "<PACKAGE_NAME>" + "example": "<PACKAGE_NAME>" } }, "required": [ @@ -48353,7 +48322,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -48367,12 +48336,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "packageName": { "type": "string", "description": "Linux package name. Max length: 256 chars.", - "x-example": "<PACKAGE_NAME>" + "example": "<PACKAGE_NAME>" } }, "required": [ @@ -48441,7 +48410,7 @@ "platformId": { "type": "string", "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PLATFORM_ID>", + "example": "<PLATFORM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -48449,12 +48418,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "hostname": { "type": "string", "description": "Platform web hostname. Max length: 256 chars.", - "x-example": "app.example.com" + "example": "app.example.com" } }, "required": [ @@ -48522,7 +48491,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -48536,12 +48505,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "hostname": { "type": "string", "description": "Platform web hostname. Max length: 256 chars.", - "x-example": "app.example.com" + "example": "app.example.com" } }, "required": [ @@ -48610,7 +48579,7 @@ "platformId": { "type": "string", "description": "Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<PLATFORM_ID>", + "example": "<PLATFORM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -48618,12 +48587,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "packageIdentifierName": { "type": "string", "description": "Windows package identifier name. Max length: 256 chars.", - "x-example": "<PACKAGE_IDENTIFIER_NAME>" + "example": "<PACKAGE_IDENTIFIER_NAME>" } }, "required": [ @@ -48691,7 +48660,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -48705,12 +48674,12 @@ "name": { "type": "string", "description": "Platform name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "packageIdentifierName": { "type": "string", "description": "Windows package identifier name. Max length: 256 chars.", - "x-example": "<PACKAGE_IDENTIFIER_NAME>" + "example": "<PACKAGE_IDENTIFIER_NAME>" } }, "required": [ @@ -48803,7 +48772,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -48855,7 +48824,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<PLATFORM_ID>" + "example": "<PLATFORM_ID>" }, "in": "path" } @@ -48932,7 +48901,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -48999,7 +48968,7 @@ "enabled": { "type": "boolean", "description": "Set whether or not to block aliased emails during signup and email updates.", - "x-example": false + "example": false } }, "required": [ @@ -49070,7 +49039,7 @@ "enabled": { "type": "boolean", "description": "Set whether or not to restrict sign-ups and email updates to corporate email addresses only.", - "x-example": false + "example": false } }, "required": [ @@ -49141,7 +49110,7 @@ "enabled": { "type": "boolean", "description": "Set whether or not to block disposable email addresses during signup and email updates.", - "x-example": false + "example": false } }, "required": [ @@ -49212,7 +49181,7 @@ "enabled": { "type": "boolean", "description": "Set whether or not to block free email addresses during signup and email updates.", - "x-example": false + "example": false } }, "required": [ @@ -49283,32 +49252,32 @@ "userId": { "type": "boolean", "description": "Set to true if you want make user ID visible to all team members, or false to hide it.", - "x-example": false + "example": false }, "userEmail": { "type": "boolean", "description": "Set to true if you want make user email visible to all team members, or false to hide it.", - "x-example": false + "example": false }, "userPhone": { "type": "boolean", "description": "Set to true if you want make user phone number visible to all team members, or false to hide it.", - "x-example": false + "example": false }, "userName": { "type": "boolean", "description": "Set to true if you want make user name visible to all team members, or false to hide it.", - "x-example": false + "example": false }, "userMFA": { "type": "boolean", "description": "Set to true if you want make user MFA status visible to all team members, or false to hide it.", - "x-example": false + "example": false }, "userAccessedAt": { "type": "boolean", "description": "Set to true if you want make user last access time visible to all team members, or false to hide it.", - "x-example": false + "example": false } } } @@ -49376,22 +49345,22 @@ "totp": { "type": "boolean", "description": "Set to true to allow TOTP to complete an MFA challenge, or false to disable it.", - "x-example": false + "example": false }, "email": { "type": "boolean", "description": "Set to true to allow email to complete an MFA challenge, or false to disable it.", - "x-example": false + "example": false }, "phone": { "type": "boolean", "description": "Set to true to allow phone (SMS) to complete an MFA challenge, or false to disable it.", - "x-example": false + "example": false }, "custom": { "type": "boolean", "description": "Set to true to allow the custom factor to complete an MFA challenge, or false to disable it.", - "x-example": false + "example": false } } } @@ -49459,7 +49428,7 @@ "enabled": { "type": "boolean", "description": "Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.", - "x-example": false + "example": false } }, "required": [ @@ -49530,9 +49499,9 @@ "total": { "type": "integer", "description": "Set the password history length per user. Value can be between 1 and 20, or null to disable the limit.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true } }, "required": [ @@ -49603,7 +49572,7 @@ "enabled": { "type": "boolean", "description": "Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.", - "x-example": false + "example": false } }, "required": [ @@ -49674,28 +49643,28 @@ "min": { "type": "integer", "description": "Minimum password length. Value must be between 8 and 256. Default is 8.", - "x-example": 8, + "example": 8, "format": "int32" }, "uppercase": { "type": "boolean", "description": "Whether passwords must include at least one uppercase letter.", - "x-example": false + "example": false }, "lowercase": { "type": "boolean", "description": "Whether passwords must include at least one lowercase letter.", - "x-example": false + "example": false }, "number": { "type": "boolean", "description": "Whether passwords must include at least one number.", - "x-example": false + "example": false }, "symbols": { "type": "boolean", "description": "Whether passwords must include at least one symbol.", - "x-example": false + "example": false } } } @@ -49763,7 +49732,7 @@ "enabled": { "type": "boolean", "description": "Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.", - "x-example": false + "example": false } }, "required": [ @@ -49834,7 +49803,7 @@ "duration": { "type": "integer", "description": "Maximum session length in seconds. Minium allowed value is 60 seconds, and maximum is 1 year, which is 31536000 seconds.", - "x-example": 60, + "example": 60, "format": "int32" } }, @@ -49906,7 +49875,7 @@ "enabled": { "type": "boolean", "description": "Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.", - "x-example": false + "example": false } }, "required": [ @@ -49977,7 +49946,7 @@ "total": { "type": "integer", "description": "Set the maximum number of sessions allowed per user. Value can be between 1 and 100.", - "x-example": 1, + "example": 1, "format": "int32" } }, @@ -50049,9 +50018,9 @@ "total": { "type": "integer", "description": "Set the maximum number of users allowed in the project. Value can be between 0 and 10000. Use 0 or null to disable the limit.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true } }, "required": [ @@ -50186,7 +50155,7 @@ "required": true, "schema": { "type": "string", - "x-example": "password-dictionary", + "example": "password-dictionary", "enum": [ "password-dictionary", "password-history", @@ -50282,7 +50251,7 @@ "required": true, "schema": { "type": "string", - "x-example": "rest", + "example": "rest", "enum": [ "rest", "graphql", @@ -50307,7 +50276,7 @@ "enabled": { "type": "boolean", "description": "Protocol status.", - "x-example": false + "example": false } }, "required": [ @@ -50373,7 +50342,7 @@ "required": true, "schema": { "type": "string", - "x-example": "account", + "example": "account", "enum": [ "account", "avatars", @@ -50430,7 +50399,7 @@ "enabled": { "type": "boolean", "description": "Service status.", - "x-example": false + "example": false } }, "required": [ @@ -50498,59 +50467,57 @@ "host": { "type": "string", "description": "SMTP server hostname (domain)", - "x-example": null, - "x-nullable": true + "nullable": true }, "port": { "type": "integer", "description": "SMTP server port", - "x-example": null, "format": "int32", - "x-nullable": true + "nullable": true }, "username": { "type": "string", "description": "SMTP server username. Pass an empty string to clear a previously set value.", - "x-example": "<USERNAME>", - "x-nullable": true + "example": "<USERNAME>", + "nullable": true }, "password": { "type": "string", "description": "SMTP server password. Pass an empty string to clear a previously set value. This property is stored securely and cannot be read in future (write-only).", - "x-example": "password", + "example": "password", "format": "password", - "x-nullable": true + "nullable": true }, "senderEmail": { "type": "string", "description": "Email address shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "senderName": { "type": "string", "description": "Name shown in inbox as the sender of the email. Pass an empty string to clear a previously set value.", - "x-example": "<SENDER_NAME>", - "x-nullable": true + "example": "<SENDER_NAME>", + "nullable": true }, "replyToEmail": { "type": "string", "description": "Email used when user replies to the email. Pass an empty string to clear a previously set value.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "replyToName": { "type": "string", "description": "Name used when user replies to the email. Pass an empty string to clear a previously set value.", - "x-example": "<REPLY_TO_NAME>", - "x-nullable": true + "example": "<REPLY_TO_NAME>", + "nullable": true }, "secure": { "type": "string", "description": "Configures if communication with SMTP server is encrypted. Allowed values are: tls, ssl. Leave empty for no encryption.", - "x-example": "tls", + "example": "tls", "enum": [ "tls", "ssl" @@ -50560,13 +50527,13 @@ "tls", "ssl" ], - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -50624,7 +50591,6 @@ "emails": { "type": "array", "description": "Array of emails to send test email to. Maximum of 10 emails are allowed.", - "x-example": null, "items": { "type": "string" } @@ -50706,7 +50672,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -50768,7 +50734,7 @@ "templateId": { "type": "string", "description": "Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession", - "x-example": "verification", + "example": "verification", "enum": [ "verification", "magicSession", @@ -50792,7 +50758,7 @@ "locale": { "type": "string", "description": "Custom email template locale. If left empty, the fallback locale (en) will be used.", - "x-example": "af", + "example": "af", "enum": [ "af", "ar-ae", @@ -51064,40 +51030,40 @@ "subject": { "type": "string", "description": "Subject of the email template. Can be up to 255 characters.", - "x-example": "<SUBJECT>", - "x-nullable": true + "example": "<SUBJECT>", + "nullable": true }, "message": { "type": "string", "description": "Plain or HTML body of the email template message. Can be up to 10MB of content.", - "x-example": "<MESSAGE>", - "x-nullable": true + "example": "<MESSAGE>", + "nullable": true }, "senderName": { "type": "string", "description": "Name of the email sender.", - "x-example": "<SENDER_NAME>", - "x-nullable": true + "example": "<SENDER_NAME>", + "nullable": true }, "senderEmail": { "type": "string", "description": "Email of the sender. Pass an empty string to clear a previously set value.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "replyToEmail": { "type": "string", "description": "Reply to email. Pass an empty string to clear a previously set value.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "replyToName": { "type": "string", "description": "Reply to name.", - "x-example": "<REPLY_TO_NAME>", - "x-nullable": true + "example": "<REPLY_TO_NAME>", + "nullable": true } }, "required": [ @@ -51163,7 +51129,7 @@ "required": true, "schema": { "type": "string", - "x-example": "verification", + "example": "verification", "enum": [ "verification", "magicSession", @@ -51192,7 +51158,7 @@ "required": false, "schema": { "type": "string", - "x-example": "af", + "example": "af", "enum": [ "af", "ar-ae", @@ -51533,7 +51499,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -51595,7 +51561,7 @@ "variableId": { "type": "string", "description": "Variable unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<VARIABLE_ID>", + "example": "<VARIABLE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -51603,18 +51569,18 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "<KEY>" + "example": "<KEY>" }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "<VALUE>" + "example": "<VALUE>" }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -51682,7 +51648,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -51741,7 +51707,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -51755,20 +51721,20 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "<KEY>", - "x-nullable": true + "example": "<KEY>", + "nullable": true }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "<VALUE>", - "x-nullable": true + "example": "<VALUE>", + "nullable": true }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -51822,7 +51788,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -51884,13 +51850,12 @@ "properties": { "domain": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Domain name." }, "type": { "type": "string", "description": "Type of reference passed. Allowed values are: tag, path, all", - "x-example": "tag", + "example": "tag", "enum": [ "tag", "path", @@ -51907,7 +51872,7 @@ "type": "string", "description": "Reference to invalidate. Depending on type this can be: cache tag name (up to 128 characters), URL path (up to 2048 characters). Not required when type is all.", "default": "", - "x-example": "<REFERENCE>" + "example": "<REFERENCE>" } }, "required": [ @@ -51987,7 +51952,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -52050,8 +52015,7 @@ "properties": { "domain": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Domain name." } }, "required": [ @@ -52118,19 +52082,18 @@ "properties": { "domain": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Domain name." }, "functionId": { "type": "string", "description": "ID of function to be executed.", - "x-example": "<FUNCTION_ID>" + "example": "<FUNCTION_ID>" }, "branch": { "type": "string", "description": "Name of VCS branch to deploy changes automatically", "default": "", - "x-example": "<BRANCH>" + "example": "<BRANCH>" } }, "required": [ @@ -52198,19 +52161,18 @@ "properties": { "domain": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Domain name." }, "url": { "type": "string", "description": "Target URL of redirection", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "statusCode": { "type": "string", "description": "Status code of redirection", - "x-example": "301", + "example": "301", "enum": [ "301", "302", @@ -52228,12 +52190,12 @@ "resourceId": { "type": "string", "description": "ID of parent resource.", - "x-example": "<RESOURCE_ID>" + "example": "<RESOURCE_ID>" }, "resourceType": { "type": "string", "description": "Type of parent resource.", - "x-example": "site", + "example": "site", "enum": [ "site", "function" @@ -52313,19 +52275,18 @@ "properties": { "domain": { "type": "string", - "description": "Domain name.", - "x-example": null + "description": "Domain name." }, "siteId": { "type": "string", "description": "ID of site to be executed.", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "branch": { "type": "string", "description": "Name of VCS branch to deploy changes automatically", "default": "", - "x-example": "<BRANCH>" + "example": "<BRANCH>" } }, "required": [ @@ -52392,7 +52353,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -52444,7 +52405,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -52505,7 +52466,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -52580,7 +52541,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -52643,7 +52604,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<REPORT_ID>" + "example": "<REPORT_ID>" }, "in": "path" } @@ -52696,7 +52657,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<REPORT_ID>" + "example": "<REPORT_ID>" }, "in": "path" } @@ -52758,7 +52719,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<REPORT_ID>" + "example": "<REPORT_ID>" }, "in": "path" }, @@ -52781,7 +52742,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -52844,7 +52805,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<REPORT_ID>" + "example": "<REPORT_ID>" }, "in": "path" }, @@ -52854,7 +52815,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSIGHT_ID>" + "example": "<INSIGHT_ID>" }, "in": "path" } @@ -52928,7 +52889,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -52939,7 +52900,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -53001,7 +52962,7 @@ "siteId": { "type": "string", "description": "Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<SITE_ID>", + "example": "<SITE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -53009,12 +52970,12 @@ "name": { "type": "string", "description": "Site name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "framework": { "type": "string", "description": "Sites framework.", - "x-example": "analog", + "example": "analog", "enum": [ "analog", "angular", @@ -53055,49 +53016,49 @@ "type": "boolean", "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", "default": true, - "x-example": false + "example": false }, "timeout": { "type": "integer", "description": "Maximum request time in seconds.", "default": 30, - "x-example": 1, + "example": 1, "format": "int32" }, "installCommand": { "type": "string", "description": "Install Command.", "default": "", - "x-example": "<INSTALL_COMMAND>" + "example": "<INSTALL_COMMAND>" }, "buildCommand": { "type": "string", "description": "Build Command.", "default": "", - "x-example": "<BUILD_COMMAND>" + "example": "<BUILD_COMMAND>" }, "startCommand": { "type": "string", "description": "Custom start command. Leave empty to use default.", "default": "", - "x-example": "<START_COMMAND>" + "example": "<START_COMMAND>" }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", "default": "", - "x-example": "<OUTPUT_DIRECTORY>" + "example": "<OUTPUT_DIRECTORY>" }, "buildRuntime": { "type": "string", "description": "Runtime to use during build step.", - "x-example": "node-14.5", + "example": "node-14.5", "enum": [ "node-14.5", "node-16.0", @@ -53131,9 +53092,6 @@ "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", @@ -53229,9 +53187,6 @@ "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", @@ -53297,7 +53252,7 @@ "adapter": { "type": "string", "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "x-example": "static", + "example": "static", "enum": [ "static", "ssr" @@ -53312,43 +53267,42 @@ "type": "string", "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", "default": "", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "fallbackFile": { "type": "string", "description": "Fallback file for single page application sites.", "default": "", - "x-example": "<FALLBACK_FILE>" + "example": "<FALLBACK_FILE>" }, "providerRepositoryId": { "type": "string", "description": "Repository ID of the repo linked to the site.", "default": "", - "x-example": "<PROVIDER_REPOSITORY_ID>" + "example": "<PROVIDER_REPOSITORY_ID>" }, "providerBranch": { "type": "string", "description": "Production branch for the repo linked to the site.", "default": "", - "x-example": "<PROVIDER_BRANCH>" + "example": "<PROVIDER_BRANCH>" }, "providerSilentMode": { "type": "boolean", "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", "default": false, - "x-example": false + "example": false }, "providerRootDirectory": { "type": "string", "description": "Path to site code in the linked repo.", "default": "", - "x-example": "<PROVIDER_ROOT_DIRECTORY>" + "example": "<PROVIDER_ROOT_DIRECTORY>" }, "providerBranches": { "type": "array", "description": "List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -53357,7 +53311,6 @@ "type": "array", "description": "List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.", "default": [], - "x-example": null, "items": { "type": "string" } @@ -53365,27 +53318,24 @@ "buildSpecification": { "type": "string", "description": "Build specification for the site deployments.", - "default": {}, - "x-example": null + "default": {} }, "runtimeSpecification": { "type": "string", "description": "Runtime specification for the SSR executions.", - "default": {}, - "x-example": null + "default": {} }, "deploymentRetention": { "type": "integer", "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "scopes": { "type": "array", "description": "List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -53721,7 +53671,7 @@ "required": false, "schema": { "type": "string", - "x-example": "runtimes", + "example": "runtimes", "default": "runtimes" }, "in": "query" @@ -53783,7 +53733,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -53842,7 +53792,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -53856,12 +53806,12 @@ "name": { "type": "string", "description": "Site name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "framework": { "type": "string", "description": "Sites framework.", - "x-example": "analog", + "example": "analog", "enum": [ "analog", "angular", @@ -53902,49 +53852,49 @@ "type": "boolean", "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", "default": true, - "x-example": false + "example": false }, "timeout": { "type": "integer", "description": "Maximum request time in seconds.", "default": 30, - "x-example": 1, + "example": 1, "format": "int32" }, "installCommand": { "type": "string", "description": "Install Command.", "default": "", - "x-example": "<INSTALL_COMMAND>" + "example": "<INSTALL_COMMAND>" }, "buildCommand": { "type": "string", "description": "Build Command.", "default": "", - "x-example": "<BUILD_COMMAND>" + "example": "<BUILD_COMMAND>" }, "startCommand": { "type": "string", "description": "Custom start command. Leave empty to use default.", "default": "", - "x-example": "<START_COMMAND>" + "example": "<START_COMMAND>" }, "outputDirectory": { "type": "string", "description": "Output Directory for site.", "default": "", - "x-example": "<OUTPUT_DIRECTORY>" + "example": "<OUTPUT_DIRECTORY>" }, "buildRuntime": { "type": "string", "description": "Runtime to use during build step.", - "x-example": "node-14.5", + "example": "node-14.5", "enum": [ "node-14.5", "node-16.0", @@ -53978,9 +53928,6 @@ "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", @@ -54076,9 +54023,6 @@ "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", @@ -54144,7 +54088,7 @@ "adapter": { "type": "string", "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "x-example": "static", + "example": "static", "enum": [ "static", "ssr" @@ -54159,79 +54103,74 @@ "type": "string", "description": "Fallback file for single page application sites.", "default": "", - "x-example": "<FALLBACK_FILE>" + "example": "<FALLBACK_FILE>" }, "installationId": { "type": "string", "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", "default": "", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "providerRepositoryId": { "type": "string", "description": "Repository ID of the repo linked to the site.", "default": "", - "x-example": "<PROVIDER_REPOSITORY_ID>" + "example": "<PROVIDER_REPOSITORY_ID>" }, "providerBranch": { "type": "string", "description": "Production branch for the repo linked to the site.", "default": "", - "x-example": "<PROVIDER_BRANCH>" + "example": "<PROVIDER_BRANCH>" }, "providerSilentMode": { "type": "boolean", "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", "default": false, - "x-example": false + "example": false }, "providerRootDirectory": { "type": "string", "description": "Path to site code in the linked repo.", "default": "", - "x-example": "<PROVIDER_ROOT_DIRECTORY>" + "example": "<PROVIDER_ROOT_DIRECTORY>" }, "providerBranches": { "type": "array", "description": "List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "providerPaths": { "type": "array", "description": "List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.", - "x-example": null, "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "buildSpecification": { "type": "string", "description": "Build specification for the site deployments.", - "x-example": null, - "x-nullable": true + "nullable": true }, "runtimeSpecification": { "type": "string", "description": "Runtime specification for the SSR executions.", - "default": {}, - "x-example": null + "default": {} }, "deploymentRetention": { "type": "integer", "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "scopes": { "type": "array", "description": "List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.", - "x-example": null, "items": { "type": "string", "enum": [ @@ -54450,7 +54389,7 @@ "usage.read" ] }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -54508,7 +54447,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -54569,7 +54508,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -54583,7 +54522,7 @@ "deploymentId": { "type": "string", "description": "Deployment ID.", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" } }, "required": [ @@ -54649,7 +54588,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -54672,7 +54611,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -54683,7 +54622,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -54743,7 +54682,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -54757,32 +54696,31 @@ "installCommand": { "type": "string", "description": "Install Commands.", - "x-example": "<INSTALL_COMMAND>", - "x-nullable": true + "example": "<INSTALL_COMMAND>", + "nullable": true }, "buildCommand": { "type": "string", "description": "Build Commands.", - "x-example": "<BUILD_COMMAND>", - "x-nullable": true + "example": "<BUILD_COMMAND>", + "nullable": true }, "outputDirectory": { "type": "string", "description": "Output Directory.", - "x-example": "<OUTPUT_DIRECTORY>", - "x-nullable": true + "example": "<OUTPUT_DIRECTORY>", + "nullable": true }, "code": { "type": "string", "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", - "x-example": null, "format": "binary" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -54848,7 +54786,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -54862,7 +54800,7 @@ "deploymentId": { "type": "string", "description": "Deployment ID.", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" } }, "required": [ @@ -54928,7 +54866,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -54942,22 +54880,22 @@ "repository": { "type": "string", "description": "Repository name of the template.", - "x-example": "<REPOSITORY>" + "example": "<REPOSITORY>" }, "owner": { "type": "string", "description": "The name of the owner of the template.", - "x-example": "<OWNER>" + "example": "<OWNER>" }, "rootDirectory": { "type": "string", "description": "Path to site code in the template repo.", - "x-example": "<ROOT_DIRECTORY>" + "example": "<ROOT_DIRECTORY>" }, "type": { "type": "string", "description": "Type for the reference provided. Can be commit, branch, or tag", - "x-example": "branch", + "example": "branch", "enum": [ "branch", "commit", @@ -54973,13 +54911,13 @@ "reference": { "type": "string", "description": "Reference value, can be a commit hash, branch name, or release tag", - "x-example": "<REFERENCE>" + "example": "<REFERENCE>" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -55049,7 +54987,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -55063,7 +55001,7 @@ "type": { "type": "string", "description": "Type of reference passed. Allowed values are: branch, commit", - "x-example": "branch", + "example": "branch", "enum": [ "branch", "commit", @@ -55079,13 +55017,13 @@ "reference": { "type": "string", "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", - "x-example": "<REFERENCE>" + "example": "<REFERENCE>" }, "activate": { "type": "boolean", "description": "Automatically activate the deployment when it is finished building.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -55152,7 +55090,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -55162,7 +55100,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" } @@ -55214,7 +55152,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -55224,7 +55162,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" } @@ -55292,7 +55230,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -55302,7 +55240,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" }, @@ -55312,7 +55250,7 @@ "required": false, "schema": { "type": "string", - "x-example": "source", + "example": "source", "enum": [ "source", "output" @@ -55332,7 +55270,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TOKEN>", + "example": "<TOKEN>", "default": "" }, "in": "query" @@ -55394,7 +55332,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -55404,7 +55342,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DEPLOYMENT_ID>" + "example": "<DEPLOYMENT_ID>" }, "in": "path" } @@ -55465,7 +55403,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -55488,7 +55426,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -55550,7 +55488,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -55560,7 +55498,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<LOG_ID>" + "example": "<LOG_ID>" }, "in": "path" } @@ -55615,7 +55553,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -55625,7 +55563,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<LOG_ID>" + "example": "<LOG_ID>" }, "in": "path" } @@ -55686,7 +55624,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -55709,7 +55647,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -55769,7 +55707,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" } @@ -55783,7 +55721,7 @@ "variableId": { "type": "string", "description": "Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<VARIABLE_ID>", + "example": "<VARIABLE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -55791,18 +55729,18 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "<KEY>" + "example": "<KEY>" }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "<VALUE>" + "example": "<VALUE>" }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -55870,7 +55808,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -55880,7 +55818,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -55939,7 +55877,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -55949,7 +55887,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -55963,20 +55901,20 @@ "key": { "type": "string", "description": "Variable key. Max length: 255 chars.", - "x-example": "<KEY>", - "x-nullable": true + "example": "<KEY>", + "nullable": true }, "value": { "type": "string", "description": "Variable value. Max length: 8192 chars.", - "x-example": "<VALUE>", - "x-nullable": true + "example": "<VALUE>", + "nullable": true }, "secret": { "type": "boolean", "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true } } } @@ -56030,7 +55968,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SITE_ID>" + "example": "<SITE_ID>" }, "in": "path" }, @@ -56040,7 +55978,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<VARIABLE_ID>" + "example": "<VARIABLE_ID>" }, "in": "path" } @@ -56115,7 +56053,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -56126,7 +56064,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -56189,7 +56127,7 @@ "bucketId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<BUCKET_ID>", + "example": "<BUCKET_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -56197,41 +56135,42 @@ "name": { "type": "string", "description": "Bucket name", - "x-example": "<NAME>" + "example": "<NAME>" }, "permissions": { "type": "array", "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "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 + "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 + "example": false }, "maximumFileSize": { "type": "integer", "description": "Maximum file size allowed in bytes. Maximum allowed value is 0B.", "default": {}, - "x-example": 1, + "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" } @@ -56240,7 +56179,7 @@ "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", + "example": "none", "enum": [ "none", "gzip", @@ -56257,19 +56196,19 @@ "type": "boolean", "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", "default": true, - "x-example": false + "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 + "example": false }, "transformations": { "type": "boolean", "description": "Are image transformations enabled?", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -56337,7 +56276,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" } @@ -56397,7 +56336,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" } @@ -56411,41 +56350,42 @@ "name": { "type": "string", "description": "Bucket name", - "x-example": "<NAME>" + "example": "<NAME>" }, "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "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 + "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 + "example": false }, "maximumFileSize": { "type": "integer", "description": "Maximum file size allowed in bytes. Maximum allowed value is 0B.", "default": {}, - "x-example": 1, + "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" } @@ -56454,7 +56394,7 @@ "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", + "example": "none", "enum": [ "none", "gzip", @@ -56471,19 +56411,19 @@ "type": "boolean", "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", "default": true, - "x-example": false + "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 + "example": false }, "transformations": { "type": "boolean", "description": "Are image transformations enabled?", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -56541,7 +56481,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" } @@ -56606,7 +56546,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -56629,7 +56569,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -56640,7 +56580,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -56704,7 +56644,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" } @@ -56718,7 +56658,7 @@ "fileId": { "type": "string", "description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<FILE_ID>", + "example": "<FILE_ID>", "x-upload-id": true, "x-appwrite": { "idGenerator": "ID.unique" @@ -56727,23 +56667,23 @@ "file": { "type": "string", "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "x-example": null, "format": "binary" }, "permissions": { "type": "array", "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "folder": { "type": "string", "description": "Virtual folder to place the file in, for example \"photos\/2026\". Nest folders with `\/`. Defaults to the bucket root.", - "default": "", - "x-example": null + "default": "" } }, "required": [ @@ -56814,7 +56754,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -56824,7 +56764,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" } @@ -56887,7 +56827,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -56897,7 +56837,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" } @@ -56911,16 +56851,18 @@ "name": { "type": "string", "description": "File name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true } } } @@ -56978,7 +56920,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -56988,7 +56930,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" } @@ -57056,7 +56998,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -57066,7 +57008,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" }, @@ -57076,7 +57018,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TOKEN>", + "example": "<TOKEN>", "default": "" }, "in": "query" @@ -57145,7 +57087,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -57155,7 +57097,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" }, @@ -57166,7 +57108,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -57178,7 +57120,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -57189,7 +57131,7 @@ "required": false, "schema": { "type": "string", - "x-example": "center", + "example": "center", "enum": [ "center", "top-left", @@ -57224,7 +57166,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -1, + "example": -1, "default": -1 }, "in": "query" @@ -57236,7 +57178,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -57258,7 +57200,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -57270,7 +57212,7 @@ "schema": { "type": "number", "format": "float", - "x-example": 0, + "example": 0, "default": 1 }, "in": "query" @@ -57282,7 +57224,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": -360, + "example": -360, "default": 0 }, "in": "query" @@ -57303,7 +57245,7 @@ "required": false, "schema": { "type": "string", - "x-example": "jpg", + "example": "jpg", "enum": [ "jpg", "jpeg", @@ -57332,7 +57274,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TOKEN>", + "example": "<TOKEN>", "default": "" }, "in": "query" @@ -57401,7 +57343,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -57411,7 +57353,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" }, @@ -57421,7 +57363,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TOKEN>", + "example": "<TOKEN>", "default": "" }, "in": "query" @@ -57497,7 +57439,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -57508,7 +57450,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -57571,7 +57513,7 @@ "databaseId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -57579,32 +57521,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.", "default": "serverless", - "x-example": "serverless" + "example": "serverless" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } }, "required": [ @@ -57799,7 +57741,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -57870,7 +57812,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -57936,7 +57878,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -57951,13 +57893,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -58018,7 +57960,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -58086,7 +58028,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -58101,7 +58043,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"tableId\": \"<TABLE_ID>\",\n\t \"rowId\": \"<ROW_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "<DATABASE_ID>", + "tableId": "<TABLE_ID>", + "rowId": "<ROW_ID>", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -58168,7 +58120,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -58228,7 +58180,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -58242,32 +58194,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.", - "x-example": "serverless", - "x-nullable": true + "example": "serverless", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } } } @@ -58322,7 +58274,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -58383,7 +58335,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -58397,8 +58349,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -58461,7 +58413,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -58520,7 +58472,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -58534,13 +58486,13 @@ "specification": { "type": "string", "description": "Dedicated compute specification to provision as the migration target (e.g. s-2vcpu-4gb). The migration always targets a dedicated compute, so `serverless` is not accepted.", - "x-example": "s-1vcpu-1gb" + "example": "s-1vcpu-1gb" }, "autoCutover": { "type": "boolean", "description": "Whether to cut over automatically once the copy is verified. When disabled the migration parks at ready_to_cutover and holds there until the cutover is performed manually.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -58606,7 +58558,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -58616,7 +58568,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MIGRATION_ID>" + "example": "<MIGRATION_ID>" }, "in": "path" } @@ -58671,7 +58623,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -58681,7 +58633,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MIGRATION_ID>" + "example": "<MIGRATION_ID>" }, "in": "path" } @@ -58742,7 +58694,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -58752,7 +58704,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MIGRATION_ID>" + "example": "<MIGRATION_ID>" }, "in": "path" } @@ -58813,7 +58765,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -58823,7 +58775,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -58834,7 +58786,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -58846,7 +58798,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -58908,7 +58860,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -58969,7 +58921,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -59034,7 +58986,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -59057,7 +59009,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -59068,7 +59020,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -59132,7 +59084,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -59146,7 +59098,7 @@ "tableId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<TABLE_ID>", + "example": "<TABLE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -59154,34 +59106,35 @@ "name": { "type": "string", "description": "Table name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "rowSecurity": { "type": "boolean", "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "columns": { "type": "array", "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, varchar, text, mediumtext, longtext, integer, bigint, double, boolean, datetime, point, linestring, polygon, email, url, ip, enum), size (integer, required for string and varchar types), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -59190,7 +59143,6 @@ "type": "array", "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", "default": [], - "x-example": null, "items": { "type": "object" } @@ -59264,7 +59216,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -59274,7 +59226,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -59337,7 +59289,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -59347,7 +59299,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -59361,34 +59313,36 @@ "name": { "type": "string", "description": "Table name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "rowSecurity": { "type": "boolean", "description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "purge": { "type": "boolean", "description": "When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.", "default": false, - "x-example": false + "example": false } } } @@ -59446,7 +59400,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -59456,7 +59410,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -59523,7 +59477,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -59533,7 +59487,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -59556,7 +59510,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -59624,7 +59578,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -59634,7 +59588,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -59647,40 +59601,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when column is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -59753,7 +59703,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -59763,7 +59713,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -59786,34 +59736,30 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when column is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -59886,7 +59832,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -59896,7 +59842,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -59909,25 +59855,24 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "boolean", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -60000,7 +59945,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -60010,7 +59955,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -60033,19 +59978,18 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "boolean", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -60118,7 +60062,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -60128,7 +60072,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -60141,26 +60085,25 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -60233,7 +60176,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -60243,7 +60186,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -60266,20 +60209,19 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -60352,7 +60294,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -60362,7 +60304,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -60375,26 +60317,25 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -60467,7 +60408,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -60477,7 +60418,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -60500,20 +60441,19 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -60586,7 +60526,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -60596,7 +60536,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -60609,13 +60549,11 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "elements": { "type": "array", "description": "Array of enum values.", - "x-example": null, "items": { "type": "string" } @@ -60623,19 +60561,19 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -60709,7 +60647,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -60719,7 +60657,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -60742,7 +60680,6 @@ "elements": { "type": "array", "description": "Updated list of enum values.", - "x-example": null, "items": { "type": "string" } @@ -60750,19 +60687,18 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -60836,7 +60772,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -60846,7 +60782,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -60859,40 +60795,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "number", "description": "Minimum value", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "max": { "type": "number", "description": "Maximum value", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "default": { "type": "number", "description": "Default value. Cannot be set when required.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -60965,7 +60897,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -60975,7 +60907,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -60998,34 +60930,30 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "number", "description": "Minimum value", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "max": { "type": "number", "description": "Maximum value", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "default": { "type": "number", "description": "Default value. Cannot be set when required.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -61098,7 +61026,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -61108,7 +61036,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -61121,40 +61049,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when column is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -61227,7 +61151,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -61237,7 +61161,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -61260,34 +61184,30 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "min": { "type": "integer", "description": "Minimum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "max": { "type": "integer", "description": "Maximum value", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "default": { "type": "integer", "description": "Default value. Cannot be set when column is required.", - "x-example": null, "format": "int64", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -61360,7 +61280,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -61370,7 +61290,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -61383,25 +61303,23 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -61474,7 +61392,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -61484,7 +61402,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -61507,19 +61425,17 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value. Cannot be set when column is required.", - "x-example": null, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -61592,7 +61508,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -61602,7 +61518,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -61615,18 +61531,30 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]]", + "example": [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ] + ], "items": { "type": "array", "items": { @@ -61634,7 +61562,7 @@ "format": "double" } }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -61707,7 +61635,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -61717,7 +61645,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -61740,12 +61668,25 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]]", + "example": [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ] + ], "items": { "type": "array", "items": { @@ -61753,13 +61694,12 @@ "format": "double" } }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -61831,7 +61771,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -61841,7 +61781,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -61854,31 +61794,30 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false }, "encrypt": { "type": "boolean", "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -61951,7 +61890,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -61961,7 +61900,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -61984,19 +61923,18 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -62069,7 +62007,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -62079,7 +62017,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -62092,31 +62030,30 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false }, "encrypt": { "type": "boolean", "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -62189,7 +62126,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -62199,7 +62136,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -62222,19 +62159,18 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -62307,7 +62243,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -62317,7 +62253,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -62330,23 +62266,25 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]", + "example": [ + 1, + 2 + ], "items": { "type": "number", "format": "double" }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -62419,7 +62357,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -62429,7 +62367,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -62452,23 +62390,25 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]", + "example": [ + 1, + 2 + ], "items": { "type": "number", "format": "double" }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -62540,7 +62480,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -62550,7 +62490,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -62563,18 +62503,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]]]", + "example": [ + [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ], + [ + 1, + 2 + ] + ] + ], "items": { "type": "array", "items": { @@ -62585,7 +62543,7 @@ } } }, - "x-nullable": true + "nullable": true } }, "required": [ @@ -62658,7 +62616,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -62668,7 +62626,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -62691,12 +62649,31 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "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]]]", + "example": [ + [ + [ + 1, + 2 + ], + [ + 3, + 4 + ], + [ + 5, + 6 + ], + [ + 1, + 2 + ] + ] + ], "items": { "type": "array", "items": { @@ -62707,13 +62684,12 @@ } } }, - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -62785,7 +62761,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -62795,7 +62771,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -62809,12 +62785,12 @@ "relatedTableId": { "type": "string", "description": "Related Table ID.", - "x-example": "<RELATED_TABLE_ID>" + "example": "<RELATED_TABLE_ID>" }, "type": { "type": "string", "description": "Relationship type. Possible values are: oneToOne, oneToMany, manyToOne, manyToMany.", - "x-example": "oneToOne", + "example": "oneToOne", "enum": [ "oneToOne", "manyToOne", @@ -62833,25 +62809,23 @@ "type": "boolean", "description": "Is Two Way?", "default": false, - "x-example": false + "example": false }, "key": { "type": "string", "description": "Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true }, "twoWayKey": { "type": "string", "description": "Two Way Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true }, "onDelete": { "type": "string", "description": "Delete constraint. Possible values are: cascade, restrict, setNull.", "default": "restrict", - "x-example": "cascade", + "example": "cascade", "enum": [ "cascade", "restrict", @@ -62939,7 +62913,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -62949,7 +62923,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -62962,37 +62936,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "size": { "type": "integer", "description": "Column size for text columns, in number of characters.", - "x-example": 1, + "example": 1, "format": "int32" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false }, "encrypt": { "type": "boolean", "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -63070,7 +63043,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -63080,7 +63053,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -63103,26 +63076,25 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "size": { "type": "integer", "description": "Maximum size of the string column.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -63195,7 +63167,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -63205,7 +63177,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -63218,31 +63190,30 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false }, "encrypt": { "type": "boolean", "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -63315,7 +63286,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -63325,7 +63296,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -63348,19 +63319,18 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -63433,7 +63403,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -63443,7 +63413,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -63456,26 +63426,25 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -63548,7 +63517,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -63558,7 +63527,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -63581,20 +63550,19 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -63667,7 +63635,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -63677,7 +63645,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -63690,37 +63658,36 @@ "properties": { "key": { "type": "string", - "description": "Column Key.", - "x-example": null + "description": "Column Key." }, "size": { "type": "integer", "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", - "x-example": 1, + "example": 1, "format": "int32" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "array": { "type": "boolean", "description": "Is column an array?", "default": false, - "x-example": false + "example": false }, "encrypt": { "type": "boolean", "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.", "default": false, - "x-example": false + "example": false } }, "required": [ @@ -63794,7 +63761,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -63804,7 +63771,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -63827,26 +63794,25 @@ "required": { "type": "boolean", "description": "Is column required?", - "x-example": false + "example": false }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "<DEFAULT>", - "x-nullable": true + "example": "<DEFAULT>", + "nullable": true }, "size": { "type": "integer", "description": "Maximum size of the varchar column.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } }, "required": [ @@ -64001,7 +63967,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -64011,7 +63977,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -64078,7 +64044,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -64088,7 +64054,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -64164,7 +64130,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -64174,7 +64140,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -64197,7 +64163,7 @@ "onDelete": { "type": "string", "description": "Delete constraint. Possible values are: cascade, restrict, setNull.", - "x-example": "cascade", + "example": "cascade", "enum": [ "cascade", "restrict", @@ -64209,13 +64175,12 @@ "restrict", "setNull" ], - "x-nullable": true + "nullable": true }, "newKey": { "type": "string", "description": "New Column Key.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -64283,7 +64248,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -64293,7 +64258,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -64316,7 +64281,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -64381,7 +64346,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -64391,7 +64356,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -64404,13 +64369,12 @@ "properties": { "key": { "type": "string", - "description": "Index Key.", - "x-example": null + "description": "Index Key." }, "type": { "type": "string", "description": "Index type.", - "x-example": "key", + "example": "key", "enum": [ "key", "fulltext", @@ -64428,7 +64392,6 @@ "columns": { "type": "array", "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.", - "x-example": null, "items": { "type": "string" } @@ -64437,7 +64400,6 @@ "type": "array", "description": "Array of index orders. Maximum of 100 orders are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -64455,7 +64417,6 @@ "type": "array", "description": "Length of index. Maximum of 100", "default": [], - "x-example": null, "items": { "type": "integer" } @@ -64531,7 +64492,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -64541,7 +64502,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -64607,7 +64568,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -64617,7 +64578,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -64694,7 +64655,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -64704,7 +64665,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -64727,7 +64688,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" }, @@ -64737,7 +64698,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -64749,7 +64710,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -64879,7 +64840,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -64889,7 +64850,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -64903,7 +64864,7 @@ "rowId": { "type": "string", "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<ROW_ID>", + "example": "<ROW_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -64912,22 +64873,29 @@ "type": "object", "description": "Row data as JSON object.", "default": {}, - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 30, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "rows": { "type": "array", "description": "Array of rows data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -64935,8 +64903,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } }, "required": [ @@ -65036,7 +65004,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -65046,7 +65014,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -65060,7 +65028,6 @@ "rows": { "type": "array", "description": "Array of row data as JSON objects. May contain partial rows.", - "x-example": null, "items": { "type": "object" } @@ -65068,8 +65035,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } }, "required": [ @@ -65137,7 +65104,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -65147,7 +65114,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" } @@ -65162,13 +65129,18 @@ "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}" + "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" } @@ -65176,8 +65148,8 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -65242,7 +65214,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -65252,7 +65224,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -65275,7 +65247,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -65343,7 +65315,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -65353,7 +65325,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -65363,7 +65335,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" }, @@ -65386,7 +65358,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -65485,7 +65457,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -65495,7 +65467,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -65505,7 +65477,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" } @@ -65520,22 +65492,30 @@ "type": "object", "description": "Row data as JSON object. Include all required columns of the row to be created or updated.", "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -65603,7 +65583,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -65613,7 +65593,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -65623,7 +65603,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" } @@ -65638,22 +65618,30 @@ "type": "object", "description": "Row data as JSON object. Include only columns 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}" + "example": { + "username": "walter.obrien", + "email": "walter.obrien@example.com", + "fullName": "Walter O'Brien", + "age": 33, + "isAdmin": false + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" }, - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -65714,7 +65702,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -65724,7 +65712,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -65734,7 +65722,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" }, @@ -65744,7 +65732,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -65812,7 +65800,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -65822,7 +65810,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -65832,7 +65820,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" }, @@ -65856,21 +65844,19 @@ "type": "number", "description": "Value to increment the column by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "min": { "type": "number", "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -65940,7 +65926,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -65950,7 +65936,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TABLE_ID>" + "example": "<TABLE_ID>" }, "in": "path" }, @@ -65960,7 +65946,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<ROW_ID>" + "example": "<ROW_ID>" }, "in": "path" }, @@ -65984,21 +65970,19 @@ "type": "number", "description": "Value to increment the column by. The value must be a number.", "default": 1, - "x-example": null, "format": "float" }, "max": { "type": "number", "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.", - "x-example": null, "format": "float", - "x-nullable": true + "nullable": true }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>", - "x-nullable": true + "example": "<TRANSACTION_ID>", + "nullable": true } } } @@ -66078,7 +66062,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -66089,7 +66073,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -66155,7 +66139,7 @@ "teamId": { "type": "string", "description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<TEAM_ID>", + "example": "<TEAM_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -66163,7 +66147,7 @@ "name": { "type": "string", "description": "Team name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "roles": { "type": "array", @@ -66171,7 +66155,6 @@ "default": [ "owner" ], - "x-example": null, "items": { "type": "string" } @@ -66245,7 +66228,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -66308,7 +66291,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -66322,7 +66305,7 @@ "name": { "type": "string", "description": "New team name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -66383,7 +66366,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -66447,7 +66430,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -66470,7 +66453,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -66533,7 +66516,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -66547,13 +66530,13 @@ "appId": { "type": "string", "description": "Application unique ID.", - "x-example": "<APP_ID>" + "example": "<APP_ID>" }, "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.", "default": "", - "x-example": "<AUTHORIZATION_DETAILS>" + "example": "<AUTHORIZATION_DETAILS>" } }, "required": [ @@ -66622,7 +66605,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -66632,7 +66615,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -66694,7 +66677,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -66704,7 +66687,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -66718,8 +66701,8 @@ "authorizationDetails": { "type": "string", "description": "Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.", - "x-example": "<AUTHORIZATION_DETAILS>", - "x-nullable": true + "example": "<AUTHORIZATION_DETAILS>", + "nullable": true } } } @@ -66779,7 +66762,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -66789,7 +66772,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<INSTALLATION_ID>" + "example": "<INSTALLATION_ID>" }, "in": "path" } @@ -66854,7 +66837,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -66877,7 +66860,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -66888,7 +66871,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -66952,7 +66935,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -66967,26 +66950,25 @@ "type": "string", "description": "Email of the new team member.", "default": "", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "userId": { "type": "string", "description": "ID of the user to be added to a team.", "default": "", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", "default": "", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" }, "roles": { "type": "array", "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", - "x-example": null, "items": { "type": "string" } @@ -66995,14 +66977,14 @@ "type": "string", "description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.", "default": "", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "format": "url" }, "name": { "type": "string", "description": "Name of the new team member. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -67072,7 +67054,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -67082,7 +67064,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -67145,7 +67127,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -67155,7 +67137,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -67169,7 +67151,6 @@ "roles": { "type": "array", "description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 81 characters long.", - "x-example": null, "items": { "type": "string" } @@ -67233,7 +67214,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -67243,7 +67224,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -67307,7 +67288,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" }, @@ -67317,7 +67298,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<MEMBERSHIP_ID>" + "example": "<MEMBERSHIP_ID>" }, "in": "path" } @@ -67331,12 +67312,12 @@ "userId": { "type": "string", "description": "User ID.", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "secret": { "type": "string", "description": "Secret key.", - "x-example": "<SECRET>" + "example": "<SECRET>" } }, "required": [ @@ -67406,7 +67387,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -67468,7 +67449,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TEAM_ID>" + "example": "<TEAM_ID>" }, "in": "path" } @@ -67483,7 +67464,7 @@ "type": "object", "description": "Prefs key-value JSON object.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -67549,7 +67530,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -67559,7 +67540,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" }, @@ -67582,7 +67563,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -67642,7 +67623,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<BUCKET_ID>" + "example": "<BUCKET_ID>" }, "in": "path" }, @@ -67652,7 +67633,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<FILE_ID>" + "example": "<FILE_ID>" }, "in": "path" } @@ -67666,9 +67647,9 @@ "expire": { "type": "string", "description": "Token expiry date", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -67731,7 +67712,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOKEN_ID>" + "example": "<TOKEN_ID>" }, "in": "path" } @@ -67790,7 +67771,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOKEN_ID>" + "example": "<TOKEN_ID>" }, "in": "path" } @@ -67804,9 +67785,9 @@ "expire": { "type": "string", "description": "File token expiry date", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "format": "datetime", - "x-nullable": true + "nullable": true } } } @@ -67860,7 +67841,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TOKEN_ID>" + "example": "<TOKEN_ID>" }, "in": "path" } @@ -67935,7 +67916,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -67946,7 +67927,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -68009,7 +67990,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -68017,29 +67998,29 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email", - "x-nullable": true + "nullable": true }, "phone": { "type": "string", "description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone", - "x-nullable": true + "nullable": true }, "password": { "type": "string", "description": "Plain text user password. Must be at least 8 chars.", "default": "", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -68108,7 +68089,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -68116,20 +68097,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using Argon2.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -68200,7 +68181,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -68208,20 +68189,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using Bcrypt.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -68303,7 +68284,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -68314,7 +68295,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -68370,7 +68351,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<IDENTITY_ID>" + "example": "<IDENTITY_ID>" }, "in": "path" } @@ -68434,7 +68415,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -68442,20 +68423,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using MD5.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -68526,7 +68507,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -68534,20 +68515,20 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using PHPass.", - "x-example": "password", + "example": "password", "format": "password" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -68618,7 +68599,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -68626,49 +68607,45 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using Scrypt.", - "x-example": "password", + "example": "password", "format": "password" }, "passwordSalt": { "type": "string", "description": "Optional salt used to hash password.", - "x-example": "<PASSWORD_SALT>" + "example": "<PASSWORD_SALT>" }, "passwordCpu": { "type": "integer", "description": "Optional CPU cost used to hash password.", - "x-example": null, "format": "int32" }, "passwordMemory": { "type": "integer", "description": "Optional memory cost used to hash password.", - "x-example": null, "format": "int32" }, "passwordParallel": { "type": "integer", "description": "Optional parallelization cost used to hash password.", - "x-example": null, "format": "int32" }, "passwordLength": { "type": "integer", "description": "Optional hash length used to hash password.", - "x-example": null, "format": "int32" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -68744,7 +68721,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -68752,35 +68729,35 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using Scrypt Modified.", - "x-example": "password", + "example": "password", "format": "password" }, "passwordSalt": { "type": "string", "description": "Salt used to hash password.", - "x-example": "<PASSWORD_SALT>" + "example": "<PASSWORD_SALT>" }, "passwordSaltSeparator": { "type": "string", "description": "Salt separator used to hash password.", - "x-example": "<PASSWORD_SALT_SEPARATOR>" + "example": "<PASSWORD_SALT_SEPARATOR>" }, "passwordSignerKey": { "type": "string", "description": "Signer key used to hash password.", - "x-example": "<PASSWORD_SIGNER_KEY>" + "example": "<PASSWORD_SIGNER_KEY>" }, "name": { "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -68854,7 +68831,7 @@ "userId": { "type": "string", "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<USER_ID>", + "example": "<USER_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -68862,19 +68839,19 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" }, "password": { "type": "string", "description": "User password hashed using SHA.", - "x-example": "password", + "example": "password", "format": "password" }, "passwordVersion": { "type": "string", "description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'", - "x-example": "sha1", + "example": "sha1", "enum": [ "sha1", "sha224", @@ -68907,7 +68884,7 @@ "type": "string", "description": "User name. Max length: 128 chars.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -68976,7 +68953,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -69029,7 +69006,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -69091,7 +69068,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -69105,7 +69082,7 @@ "email": { "type": "string", "description": "User email.", - "x-example": "email@example.com", + "example": "email@example.com", "format": "email" } }, @@ -69173,7 +69150,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -69187,7 +69164,7 @@ "impersonator": { "type": "boolean", "description": "Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.", - "x-example": false + "example": false } }, "required": [ @@ -69254,7 +69231,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -69269,13 +69246,13 @@ "type": "string", "description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.", "default": "recent", - "x-example": "<SESSION_ID>" + "example": "<SESSION_ID>" }, "duration": { "type": "integer", "description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.", "default": 900, - "x-example": 0, + "example": 0, "format": "int32" } } @@ -69340,7 +69317,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -69354,7 +69331,6 @@ "labels": { "type": "array", "description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.", - "x-example": null, "items": { "type": "string" } @@ -69424,7 +69400,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -69447,7 +69423,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -69510,7 +69486,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -69533,7 +69509,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -69544,7 +69520,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -69669,7 +69645,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -69683,7 +69659,7 @@ "mfa": { "type": "boolean", "description": "Enable or disable MFA.", - "x-example": false + "example": false } }, "required": [ @@ -69803,7 +69779,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -69813,7 +69789,7 @@ "required": true, "schema": { "type": "string", - "x-example": "totp", + "example": "totp", "enum": [ "totp" ], @@ -69909,7 +69885,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -69919,7 +69895,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<CHALLENGE_ID>" + "example": "<CHALLENGE_ID>" }, "in": "path" } @@ -70039,7 +70015,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -70159,7 +70135,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -70277,7 +70253,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -70395,7 +70371,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -70457,7 +70433,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -70471,7 +70447,7 @@ "name": { "type": "string", "description": "User name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -70538,7 +70514,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -70552,7 +70528,7 @@ "password": { "type": "string", "description": "New user password. Must be at least 8 chars.", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -70620,7 +70596,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -70634,7 +70610,7 @@ "number": { "type": "string", "description": "User phone number.", - "x-example": "+12065550100", + "example": "+12065550100", "format": "phone" } }, @@ -70702,7 +70678,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -70762,7 +70738,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -70777,7 +70753,7 @@ "type": "object", "description": "Prefs key-value JSON object.", "default": {}, - "x-example": "{}" + "example": {} } }, "required": [ @@ -70847,7 +70823,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -70857,7 +70833,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -70924,7 +70900,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -70980,7 +70956,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -71038,7 +71014,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -71048,7 +71024,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<SESSION_ID>" + "example": "<SESSION_ID>" }, "in": "path" } @@ -71110,7 +71086,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -71124,7 +71100,7 @@ "status": { "type": "boolean", "description": "User Status. To activate the user pass `true` and to block the user pass `false`.", - "x-example": false + "example": false } }, "required": [ @@ -71191,7 +71167,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -71214,7 +71190,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -71275,7 +71251,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -71289,7 +71265,7 @@ "targetId": { "type": "string", "description": "Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<TARGET_ID>", + "example": "<TARGET_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -71297,7 +71273,7 @@ "providerType": { "type": "string", "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email", + "example": "email", "enum": [ "email", "sms", @@ -71313,19 +71289,19 @@ "identifier": { "type": "string", "description": "The target identifier (token, email, phone etc.)", - "x-example": "<IDENTIFIER>" + "example": "<IDENTIFIER>" }, "providerId": { "type": "string", "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", "default": "", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "name": { "type": "string", "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } }, "required": [ @@ -71394,7 +71370,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -71404,7 +71380,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TARGET_ID>" + "example": "<TARGET_ID>" }, "in": "path" } @@ -71464,7 +71440,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -71474,7 +71450,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TARGET_ID>" + "example": "<TARGET_ID>" }, "in": "path" } @@ -71489,19 +71465,19 @@ "type": "string", "description": "The target identifier (token, email, phone etc.)", "default": "", - "x-example": "<IDENTIFIER>" + "example": "<IDENTIFIER>" }, "providerId": { "type": "string", "description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.", "default": "", - "x-example": "<PROVIDER_ID>" + "example": "<PROVIDER_ID>" }, "name": { "type": "string", "description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.", "default": "", - "x-example": "<NAME>" + "example": "<NAME>" } } } @@ -71556,7 +71532,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" }, @@ -71566,7 +71542,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TARGET_ID>" + "example": "<TARGET_ID>" }, "in": "path" } @@ -71628,7 +71604,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -71643,14 +71619,14 @@ "type": "integer", "description": "Token length in characters. The default length is 6 characters", "default": 6, - "x-example": 4, + "example": 4, "format": "int32" }, "expire": { "type": "integer", "description": "Token expiration period in seconds. The default expiration is 15 minutes.", "default": 900, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -71715,7 +71691,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -71729,7 +71705,7 @@ "emailVerification": { "type": "boolean", "description": "User email verification status.", - "x-example": false + "example": false } }, "required": [ @@ -71796,7 +71772,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<USER_ID>" + "example": "<USER_ID>" }, "in": "path" } @@ -71810,7 +71786,7 @@ "phoneVerification": { "type": "boolean", "description": "User phone verification status.", - "x-example": false + "example": false } }, "required": [ @@ -71890,7 +71866,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -71953,7 +71929,7 @@ "databaseId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DATABASE_ID>", + "example": "<DATABASE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -71961,32 +71937,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.", "default": "serverless", - "x-example": "serverless" + "example": "serverless" }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } }, "required": [ @@ -72175,7 +72151,7 @@ "type": "integer", "description": "Seconds before the transaction expires.", "default": 300, - "x-example": 60, + "example": 60, "format": "int32" } } @@ -72243,7 +72219,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -72306,7 +72282,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -72321,13 +72297,13 @@ "type": "boolean", "description": "Commit transaction?", "default": false, - "x-example": false + "example": false }, "rollback": { "type": "boolean", "description": "Rollback transaction?", "default": false, - "x-example": false + "example": false } } } @@ -72385,7 +72361,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -72450,7 +72426,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "path" } @@ -72465,7 +72441,17 @@ "type": "array", "description": "Array of staged operations.", "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "example": [ + { + "action": "create", + "databaseId": "<DATABASE_ID>", + "collectionId": "<COLLECTION_ID>", + "documentId": "<DOCUMENT_ID>", + "data": { + "name": "Walter O'Brien" + } + } + ], "items": { "type": "object" } @@ -72532,7 +72518,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -72592,7 +72578,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -72606,32 +72592,32 @@ "name": { "type": "string", "description": "Database name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "enabled": { "type": "boolean", "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false }, "specification": { "type": "string", "description": "Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.", - "x-example": "serverless", - "x-nullable": true + "example": "serverless", + "nullable": true }, "replicas": { "type": "integer", "description": "Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.", - "x-example": 0, + "example": 0, "format": "int32", - "x-nullable": true + "nullable": true }, "syncMode": { "type": "string", "description": "Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.", - "x-example": "async", - "x-nullable": true + "example": "async", + "nullable": true } }, "required": [ @@ -72689,7 +72675,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -72751,7 +72737,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -72774,7 +72760,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -72785,7 +72771,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -72846,7 +72832,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -72860,7 +72846,7 @@ "collectionId": { "type": "string", "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<COLLECTION_ID>", + "example": "<COLLECTION_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -72868,18 +72854,20 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "dimension": { "type": "integer", "description": "Embedding dimension.", - "x-example": 1, + "example": 1, "format": "int32" }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -72888,13 +72876,13 @@ "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -72963,7 +72951,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -72973,7 +72961,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -73033,7 +73021,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -73043,7 +73031,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -73057,18 +73045,20 @@ "name": { "type": "string", "description": "Collection name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "dimension": { "type": "integer", "description": "Embedding dimensions.", - "x-example": 1, + "example": 1, "format": "int32" }, "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\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -73077,13 +73067,13 @@ "type": "boolean", "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": false, - "x-example": false + "example": false }, "enabled": { "type": "boolean", "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", "default": true, - "x-example": false + "example": false } }, "required": [ @@ -73141,7 +73131,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -73151,7 +73141,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -73216,7 +73206,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -73226,7 +73216,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -73249,7 +73239,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" }, @@ -73259,7 +73249,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -73271,7 +73261,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -73396,7 +73386,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -73406,7 +73396,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -73420,7 +73410,7 @@ "documentId": { "type": "string", "description": "Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<DOCUMENT_ID>", + "example": "<DOCUMENT_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -73429,12 +73419,24 @@ "type": "object", "description": "Document data as JSON object.", "default": {}, - "x-example": "{\"embeddings\": [0.12, -0.55, 0.88, 1.02], \"metadata\": {\"key\":\"value\"} }" + "example": { + "embeddings": [ + 0.12, + -0.55, + 0.88, + 1.02 + ], + "metadata": { + "key": "value" + } + } }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -73443,7 +73445,6 @@ "type": "array", "description": "Array of documents data as JSON objects.", "default": [], - "x-example": null, "items": { "type": "object" } @@ -73451,7 +73452,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } }, "required": [ @@ -73548,7 +73549,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -73558,7 +73559,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -73572,7 +73573,6 @@ "documents": { "type": "array", "description": "Array of document data as JSON objects. May contain partial documents.", - "x-example": null, "items": { "type": "object" } @@ -73580,7 +73580,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } }, "required": [ @@ -73645,7 +73645,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -73655,7 +73655,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -73670,13 +73670,12 @@ "type": "object", "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", "default": [], - "x-example": "{}" + "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" } @@ -73684,7 +73683,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -73746,7 +73745,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -73756,7 +73755,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -73779,7 +73778,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -73844,7 +73843,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -73854,7 +73853,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -73869,7 +73868,6 @@ "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" } @@ -73877,19 +73875,19 @@ "transactionId": { "type": "string", "description": "Transaction ID to read uncommitted changes within the transaction.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "total": { "type": "boolean", "description": "When set to false, the total count returned will be 0 and will not be calculated.", "default": true, - "x-example": false + "example": false }, "ttl": { "type": "integer", "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", "default": 0, - "x-example": 0, + "example": 0, "format": "int32" } } @@ -73957,7 +73955,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -73967,7 +73965,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -73977,7 +73975,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -74000,7 +73998,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -74096,7 +74094,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74106,7 +74104,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -74119,7 +74117,7 @@ "x-appwrite": { "idGenerator": "ID.unique" }, - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" } @@ -74134,12 +74132,14 @@ "type": "object", "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -74147,7 +74147,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -74212,7 +74212,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74222,7 +74222,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -74232,7 +74232,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" } @@ -74247,12 +74247,14 @@ "type": "object", "description": "Document data as JSON object. Include only fields and value pairs to be updated.", "default": [], - "x-example": "{}" + "example": {} }, "permissions": { "type": "array", "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", + "example": [ + "read(\"any\")" + ], "items": { "type": "string" } @@ -74260,7 +74262,7 @@ "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" } } } @@ -74318,7 +74320,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74328,7 +74330,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -74338,7 +74340,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DOCUMENT_ID>" + "example": "<DOCUMENT_ID>" }, "in": "path" }, @@ -74348,7 +74350,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<TRANSACTION_ID>" + "example": "<TRANSACTION_ID>" }, "in": "query" } @@ -74410,7 +74412,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74420,7 +74422,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -74443,7 +74445,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -74504,7 +74506,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74514,7 +74516,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" } @@ -74527,13 +74529,12 @@ "properties": { "key": { "type": "string", - "description": "Index Key.", - "x-example": null + "description": "Index Key." }, "type": { "type": "string", "description": "Index type.", - "x-example": "hnsw_euclidean", + "example": "hnsw_euclidean", "enum": [ "hnsw_euclidean", "hnsw_dot", @@ -74555,7 +74556,6 @@ "attributes": { "type": "array", "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "x-example": null, "items": { "type": "string" } @@ -74564,7 +74564,6 @@ "type": "array", "description": "Array of index orders. Maximum of 100 orders are allowed.", "default": [], - "x-example": null, "items": { "type": "string", "enum": [ @@ -74582,7 +74581,6 @@ "type": "array", "description": "Length of index. Maximum of 100", "default": [], - "x-example": null, "items": { "type": "integer" } @@ -74654,7 +74652,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74664,7 +74662,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -74726,7 +74724,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74736,7 +74734,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<COLLECTION_ID>" + "example": "<COLLECTION_ID>" }, "in": "path" }, @@ -74806,7 +74804,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -74820,8 +74818,8 @@ "targetReplicaId": { "type": "string", "description": "Target replica ID to promote. If not specified, the healthiest replica is selected.", - "x-example": "<TARGET_REPLICA_ID>", - "x-nullable": true + "example": "<TARGET_REPLICA_ID>", + "nullable": true } } } @@ -74884,7 +74882,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" }, @@ -74894,7 +74892,7 @@ "required": false, "schema": { "type": "string", - "x-example": "running" + "example": "running" }, "in": "query" }, @@ -74905,7 +74903,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 1, + "example": 1, "default": 25 }, "in": "query" @@ -74917,7 +74915,7 @@ "schema": { "type": "integer", "format": "int32", - "x-example": 0, + "example": 0, "default": 0 }, "in": "query" @@ -74979,7 +74977,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -75040,7 +75038,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<DATABASE_ID>" + "example": "<DATABASE_ID>" }, "in": "path" } @@ -75115,7 +75113,7 @@ "required": false, "schema": { "type": "string", - "x-example": "<SEARCH>", + "example": "<SEARCH>", "default": "" }, "in": "query" @@ -75126,7 +75124,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -75191,7 +75189,7 @@ "ruleId": { "type": "string", "description": "Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.", - "x-example": "<RULE_ID>", + "example": "<RULE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -75199,43 +75197,42 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api" + "example": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Leave empty for the API resource type.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Optional description for the rule.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", "default": 0, - "x-example": -100000, + "example": -100000, "format": "int32" }, "enabled": { "type": "boolean", "description": "Set to false to create the rule in a disabled state.", "default": true, - "x-example": false + "example": false }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "default": [], - "x-example": null + "default": [] } }, "required": [ @@ -75304,7 +75301,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -75318,45 +75315,44 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api", - "x-nullable": true + "example": "api", + "nullable": true }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "<DESCRIPTION>", - "x-nullable": true + "example": "<DESCRIPTION>", + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", - "x-example": -100000, + "example": -100000, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Set to false to disable the rule.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -75422,7 +75418,7 @@ "ruleId": { "type": "string", "description": "Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.", - "x-example": "<RULE_ID>", + "example": "<RULE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -75430,62 +75426,61 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api" + "example": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Optional description for the rule.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "challengeType": { "type": "string", "description": "Challenge type enforced by the rule.", "default": "compute", - "x-example": "compute" + "example": "compute" }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", "default": 0, - "x-example": -100000, + "example": -100000, "format": "int32" }, "enabled": { "type": "boolean", "description": "Set to false to create the rule in a disabled state.", "default": true, - "x-example": false + "example": false }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "default": [], - "x-example": null + "default": [] }, "difficulty": { "type": "integer", "description": "Challenge difficulty from 1 (easiest) to 5 (hardest). Higher values demand more client-side proof-of-work.", "default": 3, - "x-example": 1, + "example": 1, "format": "int32" }, "ttl": { "type": "integer", "description": "How long, in seconds, a visitor stays cleared after passing the challenge before being challenged again.", "default": 1800, - "x-example": 900, + "example": 900, "format": "int32" } }, @@ -75555,7 +75550,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -75569,65 +75564,64 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api", - "x-nullable": true + "example": "api", + "nullable": true }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "<DESCRIPTION>", - "x-nullable": true + "example": "<DESCRIPTION>", + "nullable": true }, "challengeType": { "type": "string", "description": "Challenge type enforced by the rule.", - "x-example": "compute", - "x-nullable": true + "example": "compute", + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", - "x-example": -100000, + "example": -100000, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Set to false to disable the rule.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "x-example": null, - "x-nullable": true + "nullable": true }, "difficulty": { "type": "integer", "description": "Challenge difficulty from 1 (easiest) to 5 (hardest). Higher values demand more client-side proof-of-work.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "ttl": { "type": "integer", "description": "How long, in seconds, a visitor stays cleared after passing the challenge before being challenged again.", - "x-example": 900, + "example": 900, "format": "int32", - "x-nullable": true + "nullable": true } } } @@ -75693,7 +75687,7 @@ "ruleId": { "type": "string", "description": "Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.", - "x-example": "<RULE_ID>", + "example": "<RULE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -75701,43 +75695,42 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api" + "example": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Optional description for the rule.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", "default": 0, - "x-example": -100000, + "example": -100000, "format": "int32" }, "enabled": { "type": "boolean", "description": "Set to false to create the rule in a disabled state.", "default": true, - "x-example": false + "example": false }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "default": [], - "x-example": null + "default": [] } }, "required": [ @@ -75806,7 +75799,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -75820,45 +75813,44 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api", - "x-nullable": true + "example": "api", + "nullable": true }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "<DESCRIPTION>", - "x-nullable": true + "example": "<DESCRIPTION>", + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", - "x-example": -100000, + "example": -100000, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Set to false to disable the rule.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -75924,7 +75916,7 @@ "ruleId": { "type": "string", "description": "Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.", - "x-example": "<RULE_ID>", + "example": "<RULE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -75932,74 +75924,73 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api" + "example": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Optional description for the rule.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "limit": { "type": "integer", "description": "Maximum number of matching requests allowed in the configured interval.", - "x-example": 1, + "example": 1, "format": "int32" }, "interval": { "type": "integer", "description": "Interval in seconds used for rate limiting.", - "x-example": 1, + "example": 1, "format": "int32" }, "key": { "type": "string", "description": "Rate limit key. Use `ip` to limit per client IP or `userId` to limit per authenticated user. Requests without an authenticated user skip `userId` rules.", "default": "ip", - "x-example": "ip" + "example": "ip" }, "strategy": { "type": "string", "description": "Rate limit strategy. `fixedWindow` counts requests in discrete intervals, `slidingWindow` weights the previous interval for smoother limiting, and `tokenBucket` refills allowance continuously to permit short bursts.", "default": "fixedWindow", - "x-example": "fixedWindow" + "example": "fixedWindow" }, "maxBucketSize": { "type": "integer", "description": "Maximum number of tokens the bucket can hold for the `tokenBucket` strategy, controlling how large a burst is allowed. The sustained refill rate is `limit \/ interval`. Defaults to `limit` when omitted. Ignored by other strategies.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", "default": 0, - "x-example": -100000, + "example": -100000, "format": "int32" }, "enabled": { "type": "boolean", "description": "Set to false to create the rule in a disabled state.", "default": true, - "x-example": false + "example": false }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "default": [], - "x-example": null + "default": [] } }, "required": [ @@ -76070,7 +76061,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -76084,72 +76075,71 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api", - "x-nullable": true + "example": "api", + "nullable": true }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "<DESCRIPTION>", - "x-nullable": true + "example": "<DESCRIPTION>", + "nullable": true }, "limit": { "type": "integer", "description": "Maximum number of matching requests allowed in the configured interval.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "interval": { "type": "integer", "description": "Interval in seconds used for rate limiting.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "key": { "type": "string", "description": "Rate limit key. Use `ip` to limit per client IP or `userId` to limit per authenticated user. Requests without an authenticated user skip `userId` rules.", - "x-example": "ip", - "x-nullable": true + "example": "ip", + "nullable": true }, "maxBucketSize": { "type": "integer", "description": "Maximum number of tokens the bucket can hold for the `tokenBucket` strategy, controlling how large a burst is allowed. The sustained refill rate is `limit \/ interval`. Ignored by other strategies. The strategy itself cannot be changed after creation.", - "x-example": 1, + "example": 1, "format": "int32", - "x-nullable": true + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", - "x-example": -100000, + "example": -100000, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Set to false to disable the rule.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -76215,7 +76205,7 @@ "ruleId": { "type": "string", "description": "Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.", - "x-example": "<RULE_ID>", + "example": "<RULE_ID>", "x-appwrite": { "idGenerator": "ID.unique" } @@ -76223,54 +76213,53 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api" + "example": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>" + "example": "<NAME>" }, "description": { "type": "string", "description": "Optional description for the rule.", "default": "", - "x-example": "<DESCRIPTION>" + "example": "<DESCRIPTION>" }, "location": { "type": "string", "description": "Location used for redirect responses.", - "x-example": "<LOCATION>" + "example": "<LOCATION>" }, "statusCode": { "type": "integer", "description": "Integer status code used for redirect responses.", - "x-example": 300, + "example": 300, "format": "int32" }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", "default": 0, - "x-example": -100000, + "example": -100000, "format": "int32" }, "enabled": { "type": "boolean", "description": "Set to false to create the rule in a disabled state.", "default": true, - "x-example": false + "example": false }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "default": [], - "x-example": null + "default": [] } }, "required": [ @@ -76341,7 +76330,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -76355,58 +76344,57 @@ "resourceType": { "type": "string", "description": "Resource type the rule applies to.", - "x-example": "api", - "x-nullable": true + "example": "api", + "nullable": true }, "resourceId": { "type": "string", "description": "Resource identifier. Required for functions and sites.", - "x-example": "<RESOURCE_ID>", - "x-nullable": true + "example": "<RESOURCE_ID>", + "nullable": true }, "name": { "type": "string", "description": "Rule name.", - "x-example": "<NAME>", - "x-nullable": true + "example": "<NAME>", + "nullable": true }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "<DESCRIPTION>", - "x-nullable": true + "example": "<DESCRIPTION>", + "nullable": true }, "location": { "type": "string", "description": "Location used for redirect responses.", - "x-example": "<LOCATION>", - "x-nullable": true + "example": "<LOCATION>", + "nullable": true }, "statusCode": { "type": "integer", "description": "Integer status code used for redirect responses.", - "x-example": 300, + "example": 300, "format": "int32", - "x-nullable": true + "nullable": true }, "priority": { "type": "integer", "description": "Evaluation priority. Lower numbers run earlier.", - "x-example": -100000, + "example": -100000, "format": "int32", - "x-nullable": true + "nullable": true }, "enabled": { "type": "boolean", "description": "Set to false to disable the rule.", - "x-example": false, - "x-nullable": true + "example": false, + "nullable": true }, "conditions": { "type": "string", "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "x-example": null, - "x-nullable": true + "nullable": true } } } @@ -76470,7 +76458,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -76526,7 +76514,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<RULE_ID>" + "example": "<RULE_ID>" }, "in": "path" } @@ -76600,7 +76588,7 @@ "required": false, "schema": { "type": "boolean", - "x-example": false, + "example": false, "default": true }, "in": "query" @@ -76662,25 +76650,23 @@ "webhookId": { "type": "string", "description": "Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", - "x-example": "<WEBHOOK_ID>", + "example": "<WEBHOOK_ID>", "x-appwrite": { "idGenerator": "ID.unique" } }, "url": { "type": "string", - "description": "Webhook URL.", - "x-example": null + "description": "Webhook URL." }, "name": { "type": "string", "description": "Webhook name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "events": { "type": "array", "description": "Events list. Maximum of 100 events are allowed.", - "x-example": null, "items": { "type": "string" } @@ -76689,32 +76675,32 @@ "type": "boolean", "description": "Enable or disable a webhook.", "default": true, - "x-example": false + "example": false }, "tls": { "type": "boolean", "description": "Certificate verification, false for disabled or true for enabled.", "default": false, - "x-example": false + "example": false }, "authUsername": { "type": "string", "description": "Webhook HTTP user. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_USERNAME>" + "example": "<AUTH_USERNAME>" }, "authPassword": { "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "password", + "example": "password", "format": "password" }, "secret": { "type": "string", "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", - "x-example": "<SECRET>", - "x-nullable": true + "example": "<SECRET>", + "nullable": true } }, "required": [ @@ -76783,7 +76769,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<WEBHOOK_ID>" + "example": "<WEBHOOK_ID>" }, "in": "path" } @@ -76842,7 +76828,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<WEBHOOK_ID>" + "example": "<WEBHOOK_ID>" }, "in": "path" } @@ -76856,17 +76842,15 @@ "name": { "type": "string", "description": "Webhook name. Max length: 128 chars.", - "x-example": "<NAME>" + "example": "<NAME>" }, "url": { "type": "string", - "description": "Webhook URL.", - "x-example": null + "description": "Webhook URL." }, "events": { "type": "array", "description": "Events list. Maximum of 100 events are allowed.", - "x-example": null, "items": { "type": "string" } @@ -76875,25 +76859,25 @@ "type": "boolean", "description": "Enable or disable a webhook.", "default": true, - "x-example": false + "example": false }, "tls": { "type": "boolean", "description": "Certificate verification, false for disabled or true for enabled.", "default": false, - "x-example": false + "example": false }, "authUsername": { "type": "string", "description": "Webhook HTTP user. Max length: 256 chars.", "default": "", - "x-example": "<AUTH_USERNAME>" + "example": "<AUTH_USERNAME>" }, "authPassword": { "type": "string", "description": "Webhook HTTP password. Max length: 256 chars.", "default": "", - "x-example": "password", + "example": "password", "format": "password" } }, @@ -76953,7 +76937,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<WEBHOOK_ID>" + "example": "<WEBHOOK_ID>" }, "in": "path" } @@ -77014,7 +76998,7 @@ "required": true, "schema": { "type": "string", - "x-example": "<WEBHOOK_ID>" + "example": "<WEBHOOK_ID>" }, "in": "path" } @@ -77028,8 +77012,8 @@ "secret": { "type": "string", "description": "Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.", - "x-example": "<SECRET>", - "x-nullable": true + "example": "<SECRET>", + "nullable": true } } } @@ -77183,7 +77167,7 @@ "description": "Any", "type": "object", "additionalProperties": true, - "example": [] + "example": {} }, "rowList": { "description": "Rows List", @@ -77192,16 +77176,15 @@ "total": { "type": "integer", "description": "Total number of rows that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "rows": { "type": "array", "description": "List of rows.", "items": { "$ref": "#\/components\/schemas\/row" - }, - "x-example": "" + } } }, "required": [ @@ -77220,16 +77203,15 @@ "total": { "type": "integer", "description": "Total number of documents that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "documents": { "type": "array", "description": "List of documents.", "items": { "$ref": "#\/components\/schemas\/document" - }, - "x-example": "" + } } }, "required": [ @@ -77248,16 +77230,15 @@ "total": { "type": "integer", "description": "Total number of presences that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "presences": { "type": "array", "description": "List of presences.", "items": { "$ref": "#\/components\/schemas\/presence" - }, - "x-example": "" + } } }, "required": [ @@ -77276,16 +77257,15 @@ "total": { "type": "integer", "description": "Total number of tables that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "tables": { "type": "array", "description": "List of tables.", "items": { "$ref": "#\/components\/schemas\/table" - }, - "x-example": "" + } } }, "required": [ @@ -77304,16 +77284,15 @@ "total": { "type": "integer", "description": "Total number of collections that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "collections": { "type": "array", "description": "List of collections.", "items": { "$ref": "#\/components\/schemas\/collection" - }, - "x-example": "" + } } }, "required": [ @@ -77332,16 +77311,15 @@ "total": { "type": "integer", "description": "Total number of databases that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "databases": { "type": "array", "description": "List of databases.", "items": { "$ref": "#\/components\/schemas\/database" - }, - "x-example": "" + } } }, "required": [ @@ -77360,16 +77338,15 @@ "total": { "type": "integer", "description": "Total number of indexes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "indexes": { "type": "array", "description": "List of indexes.", "items": { "$ref": "#\/components\/schemas\/index" - }, - "x-example": "" + } } }, "required": [ @@ -77388,16 +77365,15 @@ "total": { "type": "integer", "description": "Total number of indexes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "indexes": { "type": "array", "description": "List of indexes.", "items": { "$ref": "#\/components\/schemas\/columnIndex" - }, - "x-example": "" + } } }, "required": [ @@ -77416,16 +77392,15 @@ "total": { "type": "integer", "description": "Total number of users that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "users": { "type": "array", "description": "List of users.", "items": { "$ref": "#\/components\/schemas\/user" - }, - "x-example": "" + } } }, "required": [ @@ -77444,16 +77419,15 @@ "total": { "type": "integer", "description": "Total number of sessions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "sessions": { "type": "array", "description": "List of sessions.", "items": { "$ref": "#\/components\/schemas\/session" - }, - "x-example": "" + } } }, "required": [ @@ -77472,16 +77446,15 @@ "total": { "type": "integer", "description": "Total number of identities that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "identities": { "type": "array", "description": "List of identities.", "items": { "$ref": "#\/components\/schemas\/identity" - }, - "x-example": "" + } } }, "required": [ @@ -77500,16 +77473,15 @@ "total": { "type": "integer", "description": "Total number of logs that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "logs": { "type": "array", "description": "List of logs.", "items": { "$ref": "#\/components\/schemas\/log" - }, - "x-example": "" + } } }, "required": [ @@ -77528,16 +77500,15 @@ "total": { "type": "integer", "description": "Total number of files that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "files": { "type": "array", "description": "List of files.", "items": { "$ref": "#\/components\/schemas\/file" - }, - "x-example": "" + } } }, "required": [ @@ -77556,16 +77527,15 @@ "total": { "type": "integer", "description": "Total number of buckets that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "buckets": { "type": "array", "description": "List of buckets.", "items": { "$ref": "#\/components\/schemas\/bucket" - }, - "x-example": "" + } } }, "required": [ @@ -77584,16 +77554,15 @@ "total": { "type": "integer", "description": "Total number of tokens that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "tokens": { "type": "array", "description": "List of tokens.", "items": { "$ref": "#\/components\/schemas\/resourceToken" - }, - "x-example": "" + } } }, "required": [ @@ -77612,16 +77581,15 @@ "total": { "type": "integer", "description": "Total number of teams that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "teams": { "type": "array", "description": "List of teams.", "items": { "$ref": "#\/components\/schemas\/team" - }, - "x-example": "" + } } }, "required": [ @@ -77640,16 +77608,15 @@ "total": { "type": "integer", "description": "Total number of memberships that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "memberships": { "type": "array", "description": "List of memberships.", "items": { "$ref": "#\/components\/schemas\/membership" - }, - "x-example": "" + } } }, "required": [ @@ -77668,16 +77635,15 @@ "total": { "type": "integer", "description": "Total number of sites that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "sites": { "type": "array", "description": "List of sites.", "items": { "$ref": "#\/components\/schemas\/site" - }, - "x-example": "" + } } }, "required": [ @@ -77696,16 +77662,15 @@ "total": { "type": "integer", "description": "Total number of functions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "functions": { "type": "array", "description": "List of functions.", "items": { "$ref": "#\/components\/schemas\/function" - }, - "x-example": "" + } } }, "required": [ @@ -77724,16 +77689,15 @@ "total": { "type": "integer", "description": "Total number of frameworks that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "frameworks": { "type": "array", "description": "List of frameworks.", "items": { "$ref": "#\/components\/schemas\/framework" - }, - "x-example": "" + } } }, "required": [ @@ -77752,16 +77716,15 @@ "total": { "type": "integer", "description": "Total number of runtimes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "runtimes": { "type": "array", "description": "List of runtimes.", "items": { "$ref": "#\/components\/schemas\/runtime" - }, - "x-example": "" + } } }, "required": [ @@ -77780,16 +77743,15 @@ "total": { "type": "integer", "description": "Total number of deployments that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "deployments": { "type": "array", "description": "List of deployments.", "items": { "$ref": "#\/components\/schemas\/deployment" - }, - "x-example": "" + } } }, "required": [ @@ -77808,16 +77770,15 @@ "total": { "type": "integer", "description": "Total number of executions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "executions": { "type": "array", "description": "List of executions.", "items": { "$ref": "#\/components\/schemas\/execution" - }, - "x-example": "" + } } }, "required": [ @@ -77836,16 +77797,15 @@ "total": { "type": "integer", "description": "Total number of projects that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "projects": { "type": "array", "description": "List of projects.", "items": { "$ref": "#\/components\/schemas\/project" - }, - "x-example": "" + } } }, "required": [ @@ -77864,16 +77824,15 @@ "total": { "type": "integer", "description": "Total number of webhooks that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "webhooks": { "type": "array", "description": "List of webhooks.", "items": { "$ref": "#\/components\/schemas\/webhook" - }, - "x-example": "" + } } }, "required": [ @@ -77892,16 +77851,15 @@ "total": { "type": "integer", "description": "Total number of keys that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "keys": { "type": "array", "description": "List of keys.", "items": { "$ref": "#\/components\/schemas\/key" - }, - "x-example": "" + } } }, "required": [ @@ -77920,16 +77878,15 @@ "total": { "type": "integer", "description": "Total number of countries that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "countries": { "type": "array", "description": "List of countries.", "items": { "$ref": "#\/components\/schemas\/country" - }, - "x-example": "" + } } }, "required": [ @@ -77948,16 +77905,15 @@ "total": { "type": "integer", "description": "Total number of continents that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "continents": { "type": "array", "description": "List of continents.", "items": { "$ref": "#\/components\/schemas\/continent" - }, - "x-example": "" + } } }, "required": [ @@ -77976,16 +77932,15 @@ "total": { "type": "integer", "description": "Total number of languages that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "languages": { "type": "array", "description": "List of languages.", "items": { "$ref": "#\/components\/schemas\/language" - }, - "x-example": "" + } } }, "required": [ @@ -78004,16 +77959,15 @@ "total": { "type": "integer", "description": "Total number of currencies that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "currencies": { "type": "array", "description": "List of currencies.", "items": { "$ref": "#\/components\/schemas\/currency" - }, - "x-example": "" + } } }, "required": [ @@ -78032,16 +77986,15 @@ "total": { "type": "integer", "description": "Total number of phones that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "phones": { "type": "array", "description": "List of phones.", "items": { "$ref": "#\/components\/schemas\/phone" - }, - "x-example": "" + } } }, "required": [ @@ -78060,16 +78013,15 @@ "total": { "type": "integer", "description": "Total number of variables that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "variables": { "type": "array", "description": "List of variables.", "items": { "$ref": "#\/components\/schemas\/variable" - }, - "x-example": "" + } } }, "required": [ @@ -78088,16 +78040,15 @@ "total": { "type": "integer", "description": "Total number of mockNumbers that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "mockNumbers": { "type": "array", "description": "List of mockNumbers.", "items": { "$ref": "#\/components\/schemas\/mockNumber" - }, - "x-example": "" + } } }, "required": [ @@ -78116,8 +78067,8 @@ "total": { "type": "integer", "description": "Total number of policies in the given project.", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 }, "policies": { "type": "array", @@ -78190,8 +78141,7 @@ "deny-corporate-email": "#\/components\/schemas\/policyDenyCorporateEmail" } } - }, - "x-example": "" + } } }, "required": [ @@ -78210,16 +78160,15 @@ "total": { "type": "integer", "description": "Total number of templates that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "templates": { "type": "array", "description": "List of templates.", "items": { "$ref": "#\/components\/schemas\/emailTemplate" - }, - "x-example": "" + } } }, "required": [ @@ -78238,16 +78187,15 @@ "total": { "type": "integer", "description": "Total number of rules that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "rules": { "type": "array", "description": "List of rules.", "items": { "$ref": "#\/components\/schemas\/proxyRule" - }, - "x-example": "" + } } }, "required": [ @@ -78266,16 +78214,15 @@ "total": { "type": "integer", "description": "Total number of localeCodes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "localeCodes": { "type": "array", "description": "List of localeCodes.", "items": { "$ref": "#\/components\/schemas\/localeCode" - }, - "x-example": "" + } } }, "required": [ @@ -78294,16 +78241,15 @@ "total": { "type": "integer", "description": "Total number of providers that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "providers": { "type": "array", "description": "List of providers.", "items": { "$ref": "#\/components\/schemas\/provider" - }, - "x-example": "" + } } }, "required": [ @@ -78322,16 +78268,15 @@ "total": { "type": "integer", "description": "Total number of messages that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "messages": { "type": "array", "description": "List of messages.", "items": { "$ref": "#\/components\/schemas\/message" - }, - "x-example": "" + } } }, "required": [ @@ -78350,16 +78295,15 @@ "total": { "type": "integer", "description": "Total number of topics that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "topics": { "type": "array", "description": "List of topics.", "items": { "$ref": "#\/components\/schemas\/topic" - }, - "x-example": "" + } } }, "required": [ @@ -78378,16 +78322,15 @@ "total": { "type": "integer", "description": "Total number of subscribers that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "subscribers": { "type": "array", "description": "List of subscribers.", "items": { "$ref": "#\/components\/schemas\/subscriber" - }, - "x-example": "" + } } }, "required": [ @@ -78406,16 +78349,15 @@ "total": { "type": "integer", "description": "Total number of targets that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "targets": { "type": "array", "description": "List of targets.", "items": { "$ref": "#\/components\/schemas\/target" - }, - "x-example": "" + } } }, "required": [ @@ -78434,16 +78376,15 @@ "total": { "type": "integer", "description": "Total number of transactions that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "transactions": { "type": "array", "description": "List of transactions.", "items": { "$ref": "#\/components\/schemas\/transaction" - }, - "x-example": "" + } } }, "required": [ @@ -78462,16 +78403,15 @@ "total": { "type": "integer", "description": "Total number of specifications that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "specifications": { "type": "array", "description": "List of specifications.", "items": { "$ref": "#\/components\/schemas\/specification" - }, - "x-example": "" + } } }, "required": [ @@ -78490,16 +78430,15 @@ "total": { "type": "integer", "description": "Total number of collections that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "collections": { "type": "array", "description": "List of collections.", "items": { "$ref": "#\/components\/schemas\/vectorsdbCollection" - }, - "x-example": "" + } } }, "required": [ @@ -78518,16 +78457,15 @@ "total": { "type": "integer", "description": "Total number of embeddings that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "embeddings": { "type": "array", "description": "List of embeddings.", "items": { "$ref": "#\/components\/schemas\/embedding" - }, - "x-example": "" + } } }, "required": [ @@ -78546,16 +78484,15 @@ "total": { "type": "integer", "description": "Total number of insights that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "insights": { "type": "array", "description": "List of insights.", "items": { "$ref": "#\/components\/schemas\/insight" - }, - "x-example": "" + } } }, "required": [ @@ -78574,16 +78511,15 @@ "total": { "type": "integer", "description": "Total number of reports that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "reports": { "type": "array", "description": "List of reports.", "items": { "$ref": "#\/components\/schemas\/report" - }, - "x-example": "" + } } }, "required": [ @@ -78602,32 +78538,32 @@ "$id": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Database name.", - "x-example": "My Database" + "example": "My Database" }, "$createdAt": { "type": "string", "description": "Database creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Database update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "enabled": { "type": "boolean", "description": "If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "example": false }, "type": { "type": "string", "description": "Database type.", - "x-example": "legacy", + "example": "legacy", "enum": [ "legacy", "tablesdb", @@ -78642,8 +78578,8 @@ "status": { "type": "string", "description": "Dedicated database lifecycle status. Null when the database has no valid dedicated backing.", - "x-example": "ready", "readOnly": true, + "example": "ready", "enum": [ "provisioning", "ready", @@ -78666,23 +78602,23 @@ "engine": { "type": "string", "description": "Underlying engine of the dedicated backing: postgresql, mysql, or mongodb. A managed product (tablesdb, documentsdb, vectorsdb) reports the engine it runs on, so its type and engine can differ. Null when the database has no dedicated backing.", - "x-example": "postgresql", "readOnly": true, + "example": "postgresql", "nullable": true }, "specification": { "type": "string", "description": "Compute specification identifier of the dedicated backing, e.g. s-2vcpu-2gb. Null when the database has no dedicated backing.", - "x-example": "s-2vcpu-2gb", "readOnly": true, + "example": "s-2vcpu-2gb", "nullable": true }, "replicas": { "type": "integer", "description": "Number of secondary high availability replicas, excluding the primary. Null when backing configuration is unavailable.", - "x-example": 0, "format": "int32", "readOnly": true, + "example": 0, "nullable": true }, "policies": { @@ -78691,7 +78627,7 @@ "items": { "$ref": "#\/components\/schemas\/backupPolicy" }, - "x-example": {}, + "example": [], "nullable": true }, "archives": { @@ -78700,7 +78636,7 @@ "items": { "$ref": "#\/components\/schemas\/backupArchive" }, - "x-example": {}, + "example": [], "nullable": true } }, @@ -78734,13 +78670,13 @@ "model": { "type": "string", "description": "Embedding model used to generate embeddings.", - "x-example": "nomic-embed-text" + "example": "nomic-embed-text" }, "dimension": { "type": "integer", "description": "Number of dimensions for each embedding vector.", - "x-example": 768, - "format": "int32" + "format": "int32", + "example": 768 }, "embedding": { "type": "array", @@ -78749,7 +78685,7 @@ "type": "number", "format": "double" }, - "x-example": [ + "example": [ 0.01, 0.02, 0.03 @@ -78758,7 +78694,7 @@ "error": { "type": "string", "description": "Error message if embedding generation fails. Empty string if no error.", - "x-example": "Error message" + "example": "Error message" } }, "required": [ @@ -78785,17 +78721,17 @@ "$id": { "type": "string", "description": "Collection ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Collection creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Collection update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -78803,29 +78739,29 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Collection name.", - "x-example": "My Collection" + "example": "My Collection" }, "enabled": { "type": "boolean", "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "example": false }, "documentSecurity": { "type": "boolean", "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "example": true }, "attributes": { "type": "array", @@ -78971,7 +78907,7 @@ } } }, - "x-example": {} + "example": [] }, "indexes": { "type": "array", @@ -78979,19 +78915,19 @@ "items": { "$ref": "#\/components\/schemas\/index" }, - "x-example": {} + "example": [] }, "bytesMax": { "type": "integer", "description": "Maximum document size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" + "format": "int32", + "example": 65535 }, "bytesUsed": { "type": "integer", "description": "Currently used document size in bytes based on defined attributes.", - "x-example": 1500, - "format": "int32" + "format": "int32", + "example": 1500 } }, "required": [ @@ -79032,8 +78968,8 @@ "total": { "type": "integer", "description": "Total number of attributes in the given collection.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "attributes": { "type": "array", @@ -79178,8 +79114,7 @@ } } } - }, - "x-example": "" + } } }, "required": [ @@ -79198,17 +79133,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -79221,45 +79156,45 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", "description": "Attribute size.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -79294,17 +79229,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "count" + "example": "count" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "integer" + "example": "integer" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -79317,48 +79252,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "integer", "description": "Minimum value to enforce for new documents.", - "x-example": 1, "format": "int64", + "example": 1, "nullable": true }, "max": { "type": "integer", "description": "Maximum value to enforce for new documents.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true }, "default": { "type": "integer", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": 10, "format": "int32", + "example": 10, "nullable": true } }, @@ -79392,17 +79327,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "count" + "example": "count" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "bigint" + "example": "bigint" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -79415,48 +79350,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "integer", "description": "Minimum value to enforce for new documents.", - "x-example": 1, "format": "int64", + "example": 1, "nullable": true }, "max": { "type": "integer", "description": "Maximum value to enforce for new documents.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true }, "default": { "type": "integer", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true } }, @@ -79490,17 +79425,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "percentageCompleted" + "example": "percentageCompleted" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "double" + "example": "double" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -79513,48 +79448,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "number", "description": "Minimum value to enforce for new documents.", - "x-example": 1.5, "format": "double", + "example": 1.5, "nullable": true }, "max": { "type": "number", "description": "Maximum value to enforce for new documents.", - "x-example": 10.5, "format": "double", + "example": 10.5, "nullable": true }, "default": { "type": "number", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": 2.5, "format": "double", + "example": 2.5, "nullable": true } }, @@ -79588,17 +79523,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "isEnabled" + "example": "isEnabled" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "boolean" + "example": "boolean" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -79611,33 +79546,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, + "example": false, "nullable": true } }, @@ -79669,17 +79604,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "userEmail" + "example": "userEmail" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -79692,38 +79627,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "email" + "example": "email" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default@example.com", + "example": "default@example.com", "nullable": true } }, @@ -79757,17 +79692,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "status" + "example": "status" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -79780,28 +79715,28 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "elements": { "type": "array", @@ -79809,17 +79744,19 @@ "items": { "type": "string" }, - "x-example": "element" + "example": [ + "element" + ] }, "format": { "type": "string", "description": "String format.", - "x-example": "enum" + "example": "enum" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "element", + "example": "element", "nullable": true } }, @@ -79855,17 +79792,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "ipAddress" + "example": "ipAddress" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -79878,38 +79815,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "ip" + "example": "ip" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "192.0.2.0", + "example": "192.0.2.0", "nullable": true } }, @@ -79943,17 +79880,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "githubUrl" + "example": "githubUrl" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -79966,38 +79903,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "url" + "example": "url" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "http:\/\/example.com", + "example": "http:\/\/example.com", "nullable": true } }, @@ -80031,17 +79968,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "birthDay" + "example": "birthDay" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "datetime" + "example": "datetime" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -80054,38 +79991,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "ISO 8601 format.", - "x-example": "datetime" + "example": "datetime" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -80119,17 +80056,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -80142,58 +80079,58 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "relatedCollection": { "type": "string", "description": "The ID of the related collection.", - "x-example": "collection" + "example": "collection" }, "relationType": { "type": "string", "description": "The type of the relationship.", - "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + "example": "oneToOne|oneToMany|manyToOne|manyToMany" }, "twoWay": { "type": "boolean", "description": "Is the relationship two-way?", - "x-example": false + "example": false }, "twoWayKey": { "type": "string", "description": "The key of the two-way relationship.", - "x-example": "string" + "example": "string" }, "onDelete": { "type": "string", "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "example": "restrict|cascade|setNull" }, "side": { "type": "string", "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "example": "parent|child" } }, "required": [ @@ -80235,17 +80172,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -80258,33 +80195,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ + "example": [ 0, 0 ], @@ -80326,17 +80263,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -80349,33 +80286,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ + "example": [ [ 0, 0 @@ -80432,17 +80369,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -80455,33 +80392,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ + "example": [ [ [ 0, @@ -80565,17 +80502,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -80588,45 +80525,45 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", "description": "Attribute size.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -80661,17 +80598,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -80684,39 +80621,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -80749,17 +80686,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -80772,39 +80709,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -80837,17 +80774,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -80860,39 +80797,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -80925,17 +80862,17 @@ "$id": { "type": "string", "description": "Collection ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Collection creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Collection update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -80943,29 +80880,29 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Collection name.", - "x-example": "My Collection" + "example": "My Collection" }, "enabled": { "type": "boolean", "description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "example": false }, "documentSecurity": { "type": "boolean", "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "example": true }, "attributes": { "type": "array", @@ -80987,7 +80924,7 @@ } } }, - "x-example": {} + "example": [] }, "indexes": { "type": "array", @@ -80995,25 +80932,25 @@ "items": { "$ref": "#\/components\/schemas\/index" }, - "x-example": {} + "example": [] }, "bytesMax": { "type": "integer", "description": "Maximum document size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" + "format": "int32", + "example": 65535 }, "bytesUsed": { "type": "integer", "description": "Currently used document size in bytes based on defined attributes.", - "x-example": 1500, - "format": "int32" + "format": "int32", + "example": 1500 }, "dimension": { "type": "integer", "description": "Embedding dimension.", - "x-example": 1536, - "format": "int32" + "format": "int32", + "example": 1536 } }, "required": [ @@ -81056,17 +80993,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -81079,28 +81016,28 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -81130,17 +81067,17 @@ "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -81153,34 +81090,34 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is attribute required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is attribute an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", "description": "Vector dimensions.", - "x-example": 1536, - "format": "int32" + "format": "int32", + "example": 1536 } }, "required": [ @@ -81212,17 +81149,17 @@ "$id": { "type": "string", "description": "Table ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Table creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Table update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -81230,29 +81167,29 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Table name.", - "x-example": "My Table" + "example": "My Table" }, "enabled": { "type": "boolean", "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.", - "x-example": false + "example": false }, "rowSecurity": { "type": "boolean", "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "example": true }, "columns": { "type": "array", @@ -81398,7 +81335,7 @@ } } }, - "x-example": {} + "example": [] }, "indexes": { "type": "array", @@ -81406,19 +81343,19 @@ "items": { "$ref": "#\/components\/schemas\/columnIndex" }, - "x-example": {} + "example": [] }, "bytesMax": { "type": "integer", "description": "Maximum row size in bytes. Returns 0 when no limit applies.", - "x-example": 65535, - "format": "int32" + "format": "int32", + "example": 65535 }, "bytesUsed": { "type": "integer", "description": "Currently used row size in bytes based on defined columns.", - "x-example": 1500, - "format": "int32" + "format": "int32", + "example": 1500 } }, "required": [ @@ -81459,8 +81396,8 @@ "total": { "type": "integer", "description": "Total number of columns in the given table.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "columns": { "type": "array", @@ -81605,8 +81542,7 @@ } } } - }, - "x-example": "" + } } }, "required": [ @@ -81625,17 +81561,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -81648,45 +81584,45 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", "description": "Column size.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -81721,17 +81657,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "count" + "example": "count" }, "type": { "type": "string", "description": "Column type.", - "x-example": "integer" + "example": "integer" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -81744,48 +81680,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "integer", "description": "Minimum value to enforce for new documents.", - "x-example": 1, "format": "int64", + "example": 1, "nullable": true }, "max": { "type": "integer", "description": "Maximum value to enforce for new documents.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true }, "default": { "type": "integer", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 10, "format": "int32", + "example": 10, "nullable": true } }, @@ -81819,17 +81755,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "count" + "example": "count" }, "type": { "type": "string", "description": "Column type.", - "x-example": "bigint" + "example": "bigint" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -81842,48 +81778,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "integer", "description": "Minimum value to enforce for new documents.", - "x-example": 1, "format": "int64", + "example": 1, "nullable": true }, "max": { "type": "integer", "description": "Maximum value to enforce for new documents.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true }, "default": { "type": "integer", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 10, "format": "int64", + "example": 10, "nullable": true } }, @@ -81917,17 +81853,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "percentageCompleted" + "example": "percentageCompleted" }, "type": { "type": "string", "description": "Column type.", - "x-example": "double" + "example": "double" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -81940,48 +81876,48 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "min": { "type": "number", "description": "Minimum value to enforce for new documents.", - "x-example": 1.5, "format": "double", + "example": 1.5, "nullable": true }, "max": { "type": "number", "description": "Maximum value to enforce for new documents.", - "x-example": 10.5, "format": "double", + "example": 10.5, "nullable": true }, "default": { "type": "number", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": 2.5, "format": "double", + "example": 2.5, "nullable": true } }, @@ -82015,17 +81951,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "isEnabled" + "example": "isEnabled" }, "type": { "type": "string", "description": "Column type.", - "x-example": "boolean" + "example": "boolean" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -82038,33 +81974,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "boolean", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": false, + "example": false, "nullable": true } }, @@ -82096,17 +82032,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "userEmail" + "example": "userEmail" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -82119,38 +82055,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "email" + "example": "email" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default@example.com", + "example": "default@example.com", "nullable": true } }, @@ -82184,17 +82120,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "status" + "example": "status" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -82207,28 +82143,28 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "elements": { "type": "array", @@ -82236,17 +82172,19 @@ "items": { "type": "string" }, - "x-example": "element" + "example": [ + "element" + ] }, "format": { "type": "string", "description": "String format.", - "x-example": "enum" + "example": "enum" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "element", + "example": "element", "nullable": true } }, @@ -82282,17 +82220,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "ipAddress" + "example": "ipAddress" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -82305,38 +82243,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "ip" + "example": "ip" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "192.0.2.0", + "example": "192.0.2.0", "nullable": true } }, @@ -82370,17 +82308,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "githubUrl" + "example": "githubUrl" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -82393,38 +82331,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "String format.", - "x-example": "url" + "example": "url" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", + "example": "https:\/\/example.com", "nullable": true } }, @@ -82458,17 +82396,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "birthDay" + "example": "birthDay" }, "type": { "type": "string", "description": "Column type.", - "x-example": "datetime" + "example": "datetime" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -82481,38 +82419,38 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "format": { "type": "string", "description": "ISO 8601 format.", - "x-example": "datetime" + "example": "datetime" }, "default": { "type": "string", "description": "Default value for column when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -82546,17 +82484,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -82569,58 +82507,58 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "relatedTable": { "type": "string", "description": "The ID of the related table.", - "x-example": "table" + "example": "table" }, "relationType": { "type": "string", "description": "The type of the relationship.", - "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" + "example": "oneToOne|oneToMany|manyToOne|manyToMany" }, "twoWay": { "type": "boolean", "description": "Is the relationship two-way?", - "x-example": false + "example": false }, "twoWayKey": { "type": "string", "description": "The key of the two-way relationship.", - "x-example": "string" + "example": "string" }, "onDelete": { "type": "string", "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "example": "restrict|cascade|setNull" }, "side": { "type": "string", "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "example": "parent|child" } }, "required": [ @@ -82662,17 +82600,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -82685,33 +82623,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ + "example": [ 0, 0 ], @@ -82753,17 +82691,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -82776,33 +82714,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ + "example": [ [ 0, 0 @@ -82859,17 +82797,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -82882,33 +82820,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ + "example": [ [ [ 0, @@ -82992,17 +82930,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -83015,45 +82953,45 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "size": { "type": "integer", "description": "Column size.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -83088,17 +83026,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -83111,39 +83049,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -83176,17 +83114,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -83199,39 +83137,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -83264,17 +83202,17 @@ "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "example": "fullName" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "example": "string" }, "status": { "type": "string", "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -83287,39 +83225,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "x-example": "string" + "example": "string" }, "required": { "type": "boolean", "description": "Is column required?", - "x-example": true + "example": true }, "array": { "type": "boolean", "description": "Is column an array?", - "x-example": false, + "example": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", + "example": "default", "nullable": true }, "encrypt": { "type": "boolean", "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "example": false, "nullable": true } }, @@ -83352,32 +83290,32 @@ "$id": { "type": "string", "description": "Index ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Index creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Index update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "key": { "type": "string", "description": "Index key.", - "x-example": "index1" + "example": "index1" }, "type": { "type": "string", "description": "Index type.", - "x-example": "primary" + "example": "primary" }, "status": { "type": "string", "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available", + "example": "available", "enum": [ "available", "processing", @@ -83389,7 +83327,7 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "example": "string" }, "attributes": { "type": "array", @@ -83397,7 +83335,7 @@ "items": { "type": "string" }, - "x-example": [] + "example": [] }, "lengths": { "type": "array", @@ -83406,7 +83344,7 @@ "type": "integer", "format": "int32" }, - "x-example": [] + "example": [] }, "orders": { "type": "array", @@ -83414,7 +83352,7 @@ "items": { "type": "string" }, - "x-example": [], + "example": [], "nullable": true } }, @@ -83449,37 +83387,37 @@ "$id": { "type": "string", "description": "Index ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Index creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Index update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "key": { "type": "string", "description": "Index Key.", - "x-example": "index1" + "example": "index1" }, "type": { "type": "string", "description": "Index type.", - "x-example": "primary" + "example": "primary" }, "status": { "type": "string", "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "x-example": "available" + "example": "available" }, "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "x-example": "string" + "example": "string" }, "columns": { "type": "array", @@ -83487,7 +83425,7 @@ "items": { "type": "string" }, - "x-example": [] + "example": [] }, "lengths": { "type": "array", @@ -83496,7 +83434,7 @@ "type": "integer", "format": "int32" }, - "x-example": [] + "example": [] }, "orders": { "type": "array", @@ -83504,7 +83442,7 @@ "items": { "type": "string" }, - "x-example": [], + "example": [], "nullable": true } }, @@ -83539,35 +83477,35 @@ "$id": { "type": "string", "description": "Row ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$sequence": { "type": "string", "description": "Row sequence ID.", - "x-example": "1", - "readOnly": true + "readOnly": true, + "example": "1" }, "$tableId": { "type": "string", "description": "Table ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$createdAt": { "type": "string", "description": "Row creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Row update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -83575,7 +83513,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] } @@ -83609,35 +83547,35 @@ "$id": { "type": "string", "description": "Document ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$sequence": { "type": "string", "description": "Document sequence ID.", - "x-example": "1", - "readOnly": true + "readOnly": true, + "example": "1" }, "$collectionId": { "type": "string", "description": "Collection ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$databaseId": { "type": "string", "description": "Database ID.", - "x-example": "5e5ea5c15117e", - "readOnly": true + "readOnly": true, + "example": "5e5ea5c15117e" }, "$createdAt": { "type": "string", "description": "Document creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Document update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -83645,7 +83583,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] } @@ -83684,17 +83622,17 @@ "$id": { "type": "string", "description": "Presence ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Presence creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Presence update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -83702,37 +83640,37 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "userId": { "type": "string", "description": "User ID.", - "x-example": "674af8f3e12a5f9ac0be" + "example": "674af8f3e12a5f9ac0be" }, "status": { "type": "string", "description": "Presence status.", - "x-example": "online", + "example": "online", "nullable": true }, "source": { "type": "string", "description": "Presence source.", - "x-example": "HTTP" + "example": "HTTP" }, "expiresAt": { "type": "string", "description": "Presence expiry date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "metadata": { "type": "object", "additionalProperties": true, "description": "Presence metadata.", - "x-example": { + "example": { "key": "value" } } @@ -83768,112 +83706,112 @@ "event": { "type": "string", "description": "Event name.", - "x-example": "account.sessions.create" + "example": "account.sessions.create" }, "userId": { "type": "string", "description": "User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "userEmail": { "type": "string", "description": "User email of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "userName": { "type": "string", "description": "User name of the actor recorded for this log. During impersonation, this is the original impersonator.", - "x-example": "John Doe" + "example": "John Doe" }, "mode": { "type": "string", "description": "API mode when event triggered.", - "x-example": "admin" + "example": "admin" }, "userType": { "type": "string", "description": "User type who triggered the audit log. Possible values: user, admin, guest, hidden, keyProject, keyAccount, keyOrganization.", - "x-example": "user" + "example": "user" }, "ip": { "type": "string", "description": "IP session in use when the session was created.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "time": { "type": "string", "description": "Log creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "osCode": { "type": "string", "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "example": "Mac" }, "osName": { "type": "string", "description": "Operating system name.", - "x-example": "Mac" + "example": "Mac" }, "osVersion": { "type": "string", "description": "Operating system version.", - "x-example": "Mac" + "example": "Mac" }, "clientType": { "type": "string", "description": "Client type.", - "x-example": "browser" + "example": "browser" }, "clientCode": { "type": "string", "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "example": "CM" }, "clientName": { "type": "string", "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "example": "Chrome Mobile iOS" }, "clientVersion": { "type": "string", "description": "Client version.", - "x-example": "84.0" + "example": "84.0" }, "clientEngine": { "type": "string", "description": "Client engine name.", - "x-example": "WebKit" + "example": "WebKit" }, "clientEngineVersion": { "type": "string", "description": "Client engine name.", - "x-example": "605.1.15" + "example": "605.1.15" }, "deviceName": { "type": "string", "description": "Device name.", - "x-example": "smartphone" + "example": "smartphone" }, "deviceBrand": { "type": "string", "description": "Device brand name.", - "x-example": "Google" + "example": "Google" }, "deviceModel": { "type": "string", "description": "Device model name.", - "x-example": "Nexus 5" + "example": "Nexus 5" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" }, "countryName": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" } }, "required": [ @@ -83932,39 +83870,39 @@ "$id": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "User creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "User update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "User name.", - "x-example": "John Doe" + "example": "John Doe" }, "password": { "type": "string", "description": "Hashed user password.", - "x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", "nullable": true }, "hash": { "type": "string", "description": "Password hashing algorithm.", - "x-example": "argon2", + "example": "argon2", "nullable": true }, "hashOptions": { "type": "object", "description": "Password hashing algorithm configuration.", - "x-example": {}, + "example": {}, "allOf": [ { "oneOf": [ @@ -84009,12 +83947,12 @@ "registration": { "type": "string", "description": "User registration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "status": { "type": "boolean", "description": "User status. Pass `true` for enabled and `false` for disabled.", - "x-example": true + "example": true }, "labels": { "type": "array", @@ -84022,74 +83960,74 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "vip" ] }, "passwordUpdate": { "type": "string", "description": "Password update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "email": { "type": "string", "description": "User email address.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "phone": { "type": "string", "description": "User phone number in E.164 format.", - "x-example": "+4930901820" + "example": "+4930901820" }, "emailVerification": { "type": "boolean", "description": "Email verification status.", - "x-example": true + "example": true }, "emailCanonical": { "type": "string", "description": "Canonical form of the user email address.", - "x-example": "john@appwrite.io", + "example": "john@appwrite.io", "nullable": true }, "emailIsFree": { "type": "boolean", "description": "Whether the user email is from a free email provider.", - "x-example": true, + "example": true, "nullable": true }, "emailIsDisposable": { "type": "boolean", "description": "Whether the user email is from a disposable email provider.", - "x-example": false, + "example": false, "nullable": true }, "emailIsCorporate": { "type": "boolean", "description": "Whether the user email is from a corporate domain.", - "x-example": true, + "example": true, "nullable": true }, "emailIsCanonical": { "type": "boolean", "description": "Whether the user email is in its canonical form.", - "x-example": true, + "example": true, "nullable": true }, "phoneVerification": { "type": "boolean", "description": "Phone verification status.", - "x-example": true + "example": true }, "mfa": { "type": "boolean", "description": "Multi factor authentication status.", - "x-example": true + "example": true }, "prefs": { "type": "object", "description": "User preferences as a key-value object", - "x-example": { + "example": { "theme": "pink", "timezone": "UTC" }, @@ -84105,23 +84043,23 @@ "items": { "$ref": "#\/components\/schemas\/target" }, - "x-example": [] + "example": [] }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "impersonator": { "type": "boolean", "description": "Whether the user can impersonate other users.", - "x-example": false, + "example": false, "nullable": true }, "impersonatorUserId": { "type": "string", "description": "ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.", - "x-example": "5e5ea5c16897e", + "example": "5e5ea5c16897e", "nullable": true } }, @@ -84184,7 +84122,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "md5" + "example": "md5" } }, "required": [ @@ -84201,7 +84139,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "sha" + "example": "sha" } }, "required": [ @@ -84218,7 +84156,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "phpass" + "example": "phpass" } }, "required": [ @@ -84235,7 +84173,7 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "bcrypt" + "example": "bcrypt" } }, "required": [ @@ -84252,31 +84190,31 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "scrypt" + "example": "scrypt" }, "costCpu": { "type": "integer", "description": "CPU complexity of computed hash.", - "x-example": 8, - "format": "int32" + "format": "int32", + "example": 8 }, "costMemory": { "type": "integer", "description": "Memory complexity of computed hash.", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "costParallel": { "type": "integer", "description": "Parallelization of computed hash.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "length": { "type": "integer", "description": "Length used to compute hash.", - "x-example": 64, - "format": "int32" + "format": "int32", + "example": 64 } }, "required": [ @@ -84301,22 +84239,22 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "scryptMod" + "example": "scryptMod" }, "salt": { "type": "string", "description": "Salt used to compute hash.", - "x-example": "UxLMreBr6tYyjQ==" + "example": "UxLMreBr6tYyjQ==" }, "saltSeparator": { "type": "string", "description": "Separator used to compute hash.", - "x-example": "Bw==" + "example": "Bw==" }, "signerKey": { "type": "string", "description": "Key used to compute hash.", - "x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + "example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" } }, "required": [ @@ -84339,25 +84277,25 @@ "type": { "type": "string", "description": "Algo type.", - "x-example": "argon2" + "example": "argon2" }, "memoryCost": { "type": "integer", "description": "Memory used to compute hash.", - "x-example": 65536, - "format": "int32" + "format": "int32", + "example": 65536 }, "timeCost": { "type": "integer", "description": "Amount of time consumed to compute hash", - "x-example": 4, - "format": "int32" + "format": "int32", + "example": 4 }, "threads": { "type": "integer", "description": "Number of threads used to compute hash.", - "x-example": 3, - "format": "int32" + "format": "int32", + "example": 3 } }, "required": [ @@ -84390,132 +84328,132 @@ "$id": { "type": "string", "description": "Session ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Session creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Session update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "expire": { "type": "string", "description": "Session expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "provider": { "type": "string", "description": "Session Provider.", - "x-example": "email" + "example": "email" }, "providerUid": { "type": "string", "description": "Session Provider User ID.", - "x-example": "user@example.com" + "example": "user@example.com" }, "providerAccessToken": { "type": "string", "description": "Session Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, "providerAccessTokenExpiry": { "type": "string", "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "providerRefreshToken": { "type": "string", "description": "Session Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, "ip": { "type": "string", "description": "IP in use when the session was created.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "osCode": { "type": "string", "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "x-example": "Mac" + "example": "Mac" }, "osName": { "type": "string", "description": "Operating system name.", - "x-example": "Mac" + "example": "Mac" }, "osVersion": { "type": "string", "description": "Operating system version.", - "x-example": "Mac" + "example": "Mac" }, "clientType": { "type": "string", "description": "Client type.", - "x-example": "browser" + "example": "browser" }, "clientCode": { "type": "string", "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "x-example": "CM" + "example": "CM" }, "clientName": { "type": "string", "description": "Client name.", - "x-example": "Chrome Mobile iOS" + "example": "Chrome Mobile iOS" }, "clientVersion": { "type": "string", "description": "Client version.", - "x-example": "84.0" + "example": "84.0" }, "clientEngine": { "type": "string", "description": "Client engine name.", - "x-example": "WebKit" + "example": "WebKit" }, "clientEngineVersion": { "type": "string", "description": "Client engine name.", - "x-example": "605.1.15" + "example": "605.1.15" }, "deviceName": { "type": "string", "description": "Device name.", - "x-example": "smartphone" + "example": "smartphone" }, "deviceBrand": { "type": "string", "description": "Device brand name.", - "x-example": "Google" + "example": "Google" }, "deviceModel": { "type": "string", "description": "Device model name.", - "x-example": "Nexus 5" + "example": "Nexus 5" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" }, "countryName": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" }, "current": { "type": "boolean", "description": "Returns true if this the current user session.", - "x-example": true + "example": true }, "factors": { "type": "array", @@ -84523,19 +84461,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "email" ] }, "secret": { "type": "string", "description": "Secret used to authenticate the user. Only included if the request was made with an API key", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "mfaUpdatedAt": { "type": "string", "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -84610,52 +84548,52 @@ "$id": { "type": "string", "description": "Identity ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Identity creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Identity update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "provider": { "type": "string", "description": "Identity Provider.", - "x-example": "email" + "example": "email" }, "providerUid": { "type": "string", "description": "ID of the User in the Identity Provider.", - "x-example": "5e5bb8c16897e" + "example": "5e5bb8c16897e" }, "providerEmail": { "type": "string", "description": "Email of the User in the Identity Provider.", - "x-example": "user@example.com" + "example": "user@example.com" }, "providerAccessToken": { "type": "string", "description": "Identity Provider Access Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" }, "providerAccessTokenExpiry": { "type": "string", "description": "The date of when the access token expires in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "providerRefreshToken": { "type": "string", "description": "Identity Provider Refresh Token.", - "x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" } }, "required": [ @@ -84690,32 +84628,32 @@ "$id": { "type": "string", "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8" }, "secret": { "type": "string", "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "example": "" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "phrase": { "type": "string", "description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.", - "x-example": "Golden Fox" + "example": "Golden Fox" } }, "required": [ @@ -84742,7 +84680,7 @@ "jwt": { "type": "string", "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" } }, "required": [ @@ -84759,104 +84697,104 @@ "ip": { "type": "string", "description": "User IP address.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "countryCode": { "type": "string", "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", - "x-example": "US" + "example": "US" }, "country": { "type": "string", "description": "Country name. This field support localization.", - "x-example": "United States" + "example": "United States" }, "continentCode": { "type": "string", "description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.", - "x-example": "NA" + "example": "NA" }, "continent": { "type": "string", "description": "Continent name. This field support localization.", - "x-example": "North America" + "example": "North America" }, "eu": { "type": "boolean", "description": "True if country is part of the European Union.", - "x-example": false + "example": false }, "currency": { "type": "string", "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", - "x-example": "USD" + "example": "USD" }, "city": { "type": "string", "description": "City", - "x-example": "Kathmandu", + "example": "Kathmandu", "nullable": true }, "timeZone": { "type": "string", "description": "Name of timezone", - "x-example": "Asia\/Kathmandu", + "example": "Asia\/Kathmandu", "nullable": true }, "postalCode": { "type": "string", "description": "Postal code", - "x-example": "44600", + "example": "44600", "nullable": true }, "latitude": { "type": "number", "description": "Latitude", - "x-example": "82.345", "format": "double", + "example": 82.345, "nullable": true }, "longitude": { "type": "number", "description": "Longitude", - "x-example": "82.345", "format": "double", + "example": 82.345, "nullable": true }, "autonomousSystemNumber": { "type": "string", "description": "Autonomous System Number (ASN) of the IP", - "x-example": "15169", + "example": "15169", "nullable": true }, "autonomousSystemOrganization": { "type": "string", "description": "Organization that owns the ASN", - "x-example": "GOOGLE", + "example": "GOOGLE", "nullable": true }, "isp": { "type": "string", "description": "Internet service provider of the IP", - "x-example": "Google", + "example": "Google", "nullable": true }, "connectionType": { "type": "string", "description": "Connection type of the IP (e.g. cable, cellular, corporate)", - "x-example": "cable", + "example": "cable", "nullable": true }, "connectionUsageType": { "type": "string", "description": "User type classification of the IP (e.g. residential, business, hosting)", - "x-example": "residential", + "example": "residential", "nullable": true }, "connectionOrganization": { "type": "string", "description": "Registered organization of the IP", - "x-example": "Google LLC", + "example": "Google LLC", "nullable": true } }, @@ -84897,12 +84835,12 @@ "code": { "type": "string", "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", - "x-example": "en-us" + "example": "en-us" }, "name": { "type": "string", "description": "Locale name", - "x-example": "US" + "example": "US" } }, "required": [ @@ -84921,22 +84859,22 @@ "$id": { "type": "string", "description": "File ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "bucketId": { "type": "string", "description": "Bucket ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "File creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "File update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -84944,68 +84882,68 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "name": { "type": "string", "description": "File name.", - "x-example": "Pink.png" + "example": "Pink.png" }, "folder": { "type": "string", "description": "Virtual folder containing the file, with a trailing slash. Empty for the bucket root.", - "x-example": "photos\/2026\/" + "example": "photos\/2026\/" }, "key": { "type": "string", "description": "Full virtual path of the file: the folder followed by the file name.", - "x-example": "photos\/2026\/Pink.png" + "example": "photos\/2026\/Pink.png" }, "signature": { "type": "string", "description": "File MD5 signature.", - "x-example": "5d529fd02b544198ae075bd57c1762bb" + "example": "5d529fd02b544198ae075bd57c1762bb" }, "mimeType": { "type": "string", "description": "File mime type.", - "x-example": "image\/png" + "example": "image\/png" }, "sizeOriginal": { "type": "integer", "description": "File original size in bytes.", - "x-example": 17890, - "format": "int32" + "format": "int32", + "example": 17890 }, "sizeActual": { "type": "integer", "description": "File actual stored size in bytes after compression and\/or encryption.", - "x-example": 12345, - "format": "int32" + "format": "int32", + "example": 12345 }, "chunksTotal": { "type": "integer", "description": "Total number of chunks available", - "x-example": 17890, - "format": "int32" + "format": "int32", + "example": 17890 }, "chunksUploaded": { "type": "integer", "description": "Total number of chunks uploaded", - "x-example": 17890, - "format": "int32" + "format": "int32", + "example": 17890 }, "encryption": { "type": "boolean", "description": "Whether file contents are encrypted at rest.", - "x-example": true + "example": true }, "compression": { "type": "string", "description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" + "example": "gzip" } }, "required": [ @@ -85054,17 +84992,17 @@ "$id": { "type": "string", "description": "Bucket ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Bucket creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Bucket update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -85072,30 +85010,30 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read(\"any\")" ] }, "fileSecurity": { "type": "boolean", "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": true + "example": true }, "name": { "type": "string", "description": "Bucket name.", - "x-example": "Documents" + "example": "Documents" }, "enabled": { "type": "boolean", "description": "Bucket enabled.", - "x-example": false + "example": false }, "maximumFileSize": { "type": "integer", "description": "Maximum file size supported.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "allowedFileExtensions": { "type": "array", @@ -85103,7 +85041,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "jpg", "png" ] @@ -85111,28 +85049,28 @@ "compression": { "type": "string", "description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).", - "x-example": "gzip" + "example": "gzip" }, "encryption": { "type": "boolean", "description": "Bucket is encrypted.", - "x-example": false + "example": false }, "antivirus": { "type": "boolean", "description": "Virus scanning is enabled.", - "x-example": false + "example": false }, "transformations": { "type": "boolean", "description": "Image transformations are enabled.", - "x-example": false + "example": false }, "totalSize": { "type": "integer", "description": "Total size of this bucket in bytes.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 } }, "required": [ @@ -85180,37 +85118,37 @@ "$id": { "type": "string", "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "resourceId": { "type": "string", "description": "Resource ID.", - "x-example": "5e5ea5c168bb8:5e5ea5c168bb8" + "example": "5e5ea5c168bb8:5e5ea5c168bb8" }, "resourceType": { "type": "string", "description": "Resource type.", - "x-example": "files" + "example": "files" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "secret": { "type": "string", "description": "JWT encoded string.", - "x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -85239,33 +85177,33 @@ "$id": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Team creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Team update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Team name.", - "x-example": "VIP" + "example": "VIP" }, "total": { "type": "integer", "description": "Total number of team members.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "prefs": { "type": "object", "description": "Team preferences as a key-value object", - "x-example": { + "example": { "theme": "pink", "timezone": "UTC" }, @@ -85303,72 +85241,72 @@ "$id": { "type": "string", "description": "Membership ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Membership creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Membership update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userName": { "type": "string", "description": "User name. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "John Doe" + "example": "John Doe" }, "userEmail": { "type": "string", "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "userPhone": { "type": "string", "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", - "x-example": "+1 555 555 5555" + "example": "+1 555 555 5555" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "teamName": { "type": "string", "description": "Team name.", - "x-example": "VIP" + "example": "VIP" }, "invited": { "type": "string", "description": "Date, the user has been invited to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "joined": { "type": "string", "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "confirm": { "type": "boolean", "description": "User confirmation status, true if the user has joined the team or false otherwise.", - "x-example": false + "example": false }, "mfa": { "type": "boolean", "description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.", - "x-example": false + "example": false }, "userAccessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "roles": { "type": "array", @@ -85376,7 +85314,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "owner" ] } @@ -85425,83 +85363,83 @@ "$id": { "type": "string", "description": "Site ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Site creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Site update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Site name.", - "x-example": "My Site" + "example": "My Site" }, "enabled": { "type": "boolean", "description": "Site enabled.", - "x-example": false + "example": false }, "live": { "type": "boolean", "description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.", - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "x-example": false + "example": false }, "framework": { "type": "string", "description": "Site framework.", - "x-example": "react" + "example": "react" }, "deploymentRetention": { "type": "integer", "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "deploymentId": { "type": "string", "description": "Site's active deployment ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "deploymentCreatedAt": { "type": "string", "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "deploymentScreenshotLight": { "type": "string", "description": "Screenshot of active deployment with light theme preference file ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "deploymentScreenshotDark": { "type": "string", "description": "Screenshot of active deployment with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "latestDeploymentId": { "type": "string", "description": "Site's latest deployment ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "latestDeploymentCreatedAt": { "type": "string", "description": "Latest deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "latestDeploymentStatus": { "type": "string", "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" + "example": "ready" }, "scopes": { "type": "array", @@ -85509,7 +85447,9 @@ "items": { "type": "string" }, - "x-example": "users.read" + "example": [ + "users.read" + ] }, "vars": { "type": "array", @@ -85517,58 +85457,58 @@ "items": { "$ref": "#\/components\/schemas\/variable" }, - "x-example": [] + "example": [] }, "timeout": { "type": "integer", "description": "Site request timeout in seconds.", - "x-example": 300, - "format": "int32" + "format": "int32", + "example": 300 }, "installCommand": { "type": "string", "description": "The install command used to install the site dependencies.", - "x-example": "npm install" + "example": "npm install" }, "buildCommand": { "type": "string", "description": "The build command used to build the site.", - "x-example": "npm run build" + "example": "npm run build" }, "startCommand": { "type": "string", "description": "Custom command to use when starting site runtime.", - "x-example": "node custom-server.mjs" + "example": "node custom-server.mjs" }, "outputDirectory": { "type": "string", "description": "The directory where the site build output is located.", - "x-example": "build" + "example": "build" }, "installationId": { "type": "string", "description": "Site VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "example": "6m40at4ejk5h2u9s1hboo" }, "providerRepositoryId": { "type": "string", "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "example": "appwrite" }, "providerBranch": { "type": "string", "description": "VCS (Version Control System) branch name", - "x-example": "main" + "example": "main" }, "providerRootDirectory": { "type": "string", "description": "Path to site in VCS (Version Control System) repository", - "x-example": "sites\/helloWorld" + "example": "sites\/helloWorld" }, "providerSilentMode": { "type": "boolean", "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "example": false }, "providerBranches": { "type": "array", @@ -85576,7 +85516,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "main", "feat\/*" ] @@ -85587,7 +85527,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "src\/**", "!docs\/**" ] @@ -85595,27 +85535,27 @@ "buildSpecification": { "type": "string", "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb" }, "runtimeSpecification": { "type": "string", "description": "Machine specification for SSR executions.", - "x-example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb" }, "buildRuntime": { "type": "string", "description": "Site build runtime.", - "x-example": "node-22" + "example": "node-22" }, "adapter": { "type": "string", "description": "Site framework adapter.", - "x-example": "static" + "example": "static" }, "fallbackFile": { "type": "string", "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "example": "index.html" } }, "required": [ @@ -85706,17 +85646,17 @@ "$id": { "type": "string", "description": "Function ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Function creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Function update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "execute": { "type": "array", @@ -85724,63 +85664,65 @@ "items": { "type": "string" }, - "x-example": "users" + "example": [ + "users" + ] }, "name": { "type": "string", "description": "Function name.", - "x-example": "My Function" + "example": "My Function" }, "enabled": { "type": "boolean", "description": "Function enabled.", - "x-example": false + "example": false }, "live": { "type": "boolean", "description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.", - "x-example": false + "example": false }, "logging": { "type": "boolean", "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", - "x-example": false + "example": false }, "runtime": { "type": "string", "description": "Function execution and build runtime.", - "x-example": "python-3.8" + "example": "python-3.8" }, "deploymentRetention": { "type": "integer", "description": "How many days to keep the non-active deployments before they will be automatically deleted.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "deploymentId": { "type": "string", "description": "Function's active deployment ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "deploymentCreatedAt": { "type": "string", "description": "Active deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "latestDeploymentId": { "type": "string", "description": "Function's latest deployment ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "latestDeploymentCreatedAt": { "type": "string", "description": "Latest deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "latestDeploymentStatus": { "type": "string", "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "x-example": "ready" + "example": "ready" }, "scopes": { "type": "array", @@ -85788,7 +85730,9 @@ "items": { "type": "string" }, - "x-example": "users.read" + "example": [ + "users.read" + ] }, "vars": { "type": "array", @@ -85796,7 +85740,7 @@ "items": { "$ref": "#\/components\/schemas\/variable" }, - "x-example": [] + "example": [] }, "events": { "type": "array", @@ -85804,58 +85748,60 @@ "items": { "type": "string" }, - "x-example": "account.create" + "example": [ + "account.create" + ] }, "schedule": { "type": "string", "description": "Function execution schedule in CRON format.", - "x-example": "5 4 * * *" + "example": "5 4 * * *" }, "timeout": { "type": "integer", "description": "Function execution timeout in seconds.", - "x-example": 300, - "format": "int32" + "format": "int32", + "example": 300 }, "entrypoint": { "type": "string", "description": "The entrypoint file used to execute the deployment.", - "x-example": "index.js" + "example": "index.js" }, "commands": { "type": "string", "description": "The build command used to build the deployment.", - "x-example": "npm install" + "example": "npm install" }, "version": { "type": "string", "description": "Version of Open Runtimes used for the function.", - "x-example": "v2" + "example": "v2" }, "installationId": { "type": "string", "description": "Function VCS (Version Control System) installation id.", - "x-example": "6m40at4ejk5h2u9s1hboo" + "example": "6m40at4ejk5h2u9s1hboo" }, "providerRepositoryId": { "type": "string", "description": "VCS (Version Control System) Repository ID", - "x-example": "appwrite" + "example": "appwrite" }, "providerBranch": { "type": "string", "description": "VCS (Version Control System) branch name", - "x-example": "main" + "example": "main" }, "providerRootDirectory": { "type": "string", "description": "Path to function in VCS (Version Control System) repository", - "x-example": "functions\/helloWorld" + "example": "functions\/helloWorld" }, "providerSilentMode": { "type": "boolean", "description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests", - "x-example": false + "example": false }, "providerBranches": { "type": "array", @@ -85863,7 +85809,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "main", "feat\/*" ] @@ -85874,7 +85820,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "src\/**", "!docs\/**" ] @@ -85882,12 +85828,12 @@ "buildSpecification": { "type": "string", "description": "Machine specification for deployment builds.", - "x-example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb" }, "runtimeSpecification": { "type": "string", "description": "Machine specification for executions.", - "x-example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb" } }, "required": [ @@ -85972,37 +85918,37 @@ "$id": { "type": "string", "description": "Runtime ID.", - "x-example": "python-3.8" + "example": "python-3.8" }, "key": { "type": "string", "description": "Parent runtime key.", - "x-example": "python" + "example": "python" }, "name": { "type": "string", "description": "Runtime Name.", - "x-example": "Python" + "example": "Python" }, "version": { "type": "string", "description": "Runtime version.", - "x-example": "3.8" + "example": "3.8" }, "base": { "type": "string", "description": "Base Docker image used to build the runtime.", - "x-example": "python:3.8-alpine" + "example": "python:3.8-alpine" }, "image": { "type": "string", "description": "Image name of Docker Hub.", - "x-example": "appwrite\\\/runtime-for-python:3.8" + "example": "appwrite\\\/runtime-for-python:3.8" }, "logo": { "type": "string", "description": "Name of the logo image.", - "x-example": "python.png" + "example": "python.png" }, "supports": { "type": "array", @@ -86010,7 +85956,9 @@ "items": { "type": "string" }, - "x-example": "amd64" + "example": [ + "amd64" + ] } }, "required": [ @@ -86041,17 +85989,17 @@ "key": { "type": "string", "description": "Framework key.", - "x-example": "sveltekit" + "example": "sveltekit" }, "name": { "type": "string", "description": "Framework Name.", - "x-example": "SvelteKit" + "example": "SvelteKit" }, "buildRuntime": { "type": "string", "description": "Default runtime version.", - "x-example": "node-22" + "example": "node-22" }, "runtimes": { "type": "array", @@ -86059,7 +86007,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "static-1", "node-22" ] @@ -86070,7 +86018,7 @@ "items": { "$ref": "#\/components\/schemas\/frameworkAdapter" }, - "x-example": [ + "example": [ { "key": "static", "buildRuntime": "node-22", @@ -86114,27 +86062,27 @@ "key": { "type": "string", "description": "Adapter key.", - "x-example": "static" + "example": "static" }, "installCommand": { "type": "string", "description": "Default command to download dependencies.", - "x-example": "npm install" + "example": "npm install" }, "buildCommand": { "type": "string", "description": "Default command to build site into output directory.", - "x-example": "npm run build" + "example": "npm run build" }, "outputDirectory": { "type": "string", "description": "Default output directory of build.", - "x-example": ".\/dist" + "example": ".\/dist" }, "fallbackFile": { "type": "string", "description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.", - "x-example": "index.html" + "example": "index.html" } }, "required": [ @@ -86159,80 +86107,80 @@ "$id": { "type": "string", "description": "Deployment ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Deployment creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Deployment update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "type": { "type": "string", "description": "Type of deployment.", - "x-example": "vcs" + "example": "vcs" }, "resourceId": { "type": "string", "description": "Resource ID.", - "x-example": "5e5ea6g16897e" + "example": "5e5ea6g16897e" }, "resourceType": { "type": "string", "description": "Resource type.", - "x-example": "functions" + "example": "functions" }, "entrypoint": { "type": "string", "description": "The entrypoint file to use to execute the deployment code.", - "x-example": "index.js" + "example": "index.js" }, "sourceSize": { "type": "integer", "description": "The code size in bytes.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "buildSize": { "type": "integer", "description": "The build output size in bytes.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "totalSize": { "type": "integer", "description": "The total size in bytes (source and build output).", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "buildId": { "type": "string", "description": "The current build ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "activate": { "type": "boolean", "description": "Whether the deployment should be automatically activated.", - "x-example": true + "example": true }, "screenshotLight": { "type": "string", "description": "Screenshot with light theme preference file ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "screenshotDark": { "type": "string", "description": "Screenshot with dark theme preference file ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "status": { "type": "string", "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", - "x-example": "ready", + "example": "ready", "enum": [ "waiting", "processing", @@ -86245,63 +86193,63 @@ "buildLogs": { "type": "string", "description": "The build logs.", - "x-example": "Compiling source files..." + "example": "Compiling source files..." }, "buildDuration": { "type": "integer", "description": "The current build time in seconds.", - "x-example": 128, - "format": "int32" + "format": "int32", + "example": 128 }, "providerRepositoryName": { "type": "string", "description": "The name of the vcs provider repository", - "x-example": "database" + "example": "database" }, "providerRepositoryOwner": { "type": "string", "description": "The name of the vcs provider repository owner", - "x-example": "utopia" + "example": "utopia" }, "providerRepositoryUrl": { "type": "string", "description": "The url of the vcs provider repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" + "example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" }, "providerCommitHash": { "type": "string", "description": "The commit hash of the vcs commit", - "x-example": "7c3f25d" + "example": "7c3f25d" }, "providerCommitAuthorUrl": { "type": "string", "description": "The url of vcs commit author", - "x-example": "https:\/\/github.com\/vermakhushboo" + "example": "https:\/\/github.com\/vermakhushboo" }, "providerCommitAuthor": { "type": "string", "description": "The name of vcs commit author", - "x-example": "Khushboo Verma" + "example": "Khushboo Verma" }, "providerCommitMessage": { "type": "string", "description": "The commit message", - "x-example": "Update index.js" + "example": "Update index.js" }, "providerCommitUrl": { "type": "string", "description": "The url of the vcs commit", - "x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + "example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" }, "providerBranch": { "type": "string", "description": "The branch of the vcs repository", - "x-example": "0.7.x" + "example": "0.7.x" }, "providerBranchUrl": { "type": "string", "description": "The branch of the vcs repository", - "x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" } }, "required": [ @@ -86370,17 +86318,17 @@ "$id": { "type": "string", "description": "Execution ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Execution creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Execution update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$permissions": { "type": "array", @@ -86388,19 +86336,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "any" ] }, "resourceId": { "type": "string", "description": "Function or site ID.", - "x-example": "5e5ea6g16897e" + "example": "5e5ea6g16897e" }, "resourceType": { "type": "string", "description": "Execution resource type.", - "x-example": "functions", + "example": "functions", "enum": [ "functions", "sites" @@ -86409,12 +86357,12 @@ "deploymentId": { "type": "string", "description": "Deployment ID used to create the execution.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "trigger": { "type": "string", "description": "The trigger that caused the resource to execute. Possible values can be: `http`, `schedule`, or `event`.", - "x-example": "http", + "example": "http", "enum": [ "http", "schedule", @@ -86424,7 +86372,7 @@ "status": { "type": "string", "description": "The status of the resource execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.", - "x-example": "processing", + "example": "processing", "enum": [ "waiting", "processing", @@ -86436,12 +86384,12 @@ "requestMethod": { "type": "string", "description": "HTTP request method type.", - "x-example": "GET" + "example": "GET" }, "requestPath": { "type": "string", "description": "HTTP request path and query.", - "x-example": "\/articles?id=5" + "example": "\/articles?id=5" }, "requestHeaders": { "type": "array", @@ -86449,7 +86397,7 @@ "items": { "$ref": "#\/components\/schemas\/headers" }, - "x-example": [ + "example": [ { "Content-Type": "application\/json" } @@ -86458,13 +86406,13 @@ "responseStatusCode": { "type": "integer", "description": "HTTP response status code.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 }, "responseBody": { "type": "string", "description": "HTTP response body. This will return empty unless execution is created as synchronous.", - "x-example": "" + "example": "" }, "responseHeaders": { "type": "array", @@ -86472,7 +86420,7 @@ "items": { "$ref": "#\/components\/schemas\/headers" }, - "x-example": [ + "example": [ { "Content-Type": "application\/json" } @@ -86481,23 +86429,23 @@ "logs": { "type": "string", "description": "Resource logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "example": "" }, "errors": { "type": "string", "description": "Resource errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.", - "x-example": "" + "example": "" }, "duration": { "type": "number", "description": "Resource(function\/site) execution duration in seconds.", - "x-example": 0.4, - "format": "double" + "format": "double", + "example": 0.4 }, "scheduledAt": { "type": "string", "description": "The scheduled time for execution. If left empty, execution will be queued immediately.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -86560,32 +86508,32 @@ "$id": { "type": "string", "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Project creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Project update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Project name.", - "x-example": "New Project" + "example": "New Project" }, "teamId": { "type": "string", "description": "Project team ID.", - "x-example": "1592981250" + "example": "1592981250" }, "region": { "type": "string", "description": "Project region", - "x-example": "fra" + "example": "fra" }, "devKeys": { "type": "array", @@ -86593,70 +86541,70 @@ "items": { "$ref": "#\/components\/schemas\/devKey" }, - "x-example": {} + "example": [] }, "smtpEnabled": { "type": "boolean", "description": "Status for custom SMTP", - "x-example": false + "example": false }, "smtpSenderName": { "type": "string", "description": "SMTP sender name", - "x-example": "John Appwrite" + "example": "John Appwrite" }, "smtpSenderEmail": { "type": "string", "description": "SMTP sender email", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "smtpReplyToName": { "type": "string", "description": "SMTP reply to name", - "x-example": "Support Team" + "example": "Support Team" }, "smtpReplyToEmail": { "type": "string", "description": "SMTP reply to email", - "x-example": "support@appwrite.io" + "example": "support@appwrite.io" }, "smtpHost": { "type": "string", "description": "SMTP server host name", - "x-example": "mail.appwrite.io" + "example": "mail.appwrite.io" }, "smtpPort": { "type": "integer", "description": "SMTP server port", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "smtpUsername": { "type": "string", "description": "SMTP server username", - "x-example": "emailuser" + "example": "emailuser" }, "smtpPassword": { "type": "string", "description": "SMTP server password. This property is write-only and always returned empty.", - "x-example": "smtp-password", - "format": "password" + "format": "password", + "example": "smtp-password" }, "smtpSecure": { "type": "string", "description": "SMTP server secure protocol", - "x-example": "tls" + "example": "tls" }, "pingCount": { "type": "integer", "description": "Number of times the ping was received for this project.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "pingedAt": { "type": "string", "description": "Last ping datetime in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "labels": { "type": "array", @@ -86664,20 +86612,20 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "vip" ] }, "status": { "type": "string", "description": "Project status", - "x-example": "active" + "example": "active" }, "onboarding": { "type": "object", "additionalProperties": true, "description": "Stage progress (completed or skipped) with timestamps and actor types, keyed by stage id.", - "x-example": [] + "example": {} }, "authMethods": { "type": "array", @@ -86685,7 +86633,7 @@ "items": { "$ref": "#\/components\/schemas\/projectAuthMethod" }, - "x-example": {} + "example": [] }, "services": { "type": "array", @@ -86693,7 +86641,7 @@ "items": { "$ref": "#\/components\/schemas\/projectService" }, - "x-example": {} + "example": [] }, "protocols": { "type": "array", @@ -86701,30 +86649,28 @@ "items": { "$ref": "#\/components\/schemas\/projectProtocol" }, - "x-example": {} + "example": [] }, "blocks": { "type": "array", "description": "Project blocks information", "items": { "$ref": "#\/components\/schemas\/block" - }, - "x-example": "" + } }, "consoleAccessedAt": { "type": "string", "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "wafEnabled": { "type": "boolean", "description": "Whether WAF enforcement is enabled for the project.", - "x-example": true + "example": true }, "billingLimits": { "type": "object", "description": "Billing limits reached", - "x-example": "", "allOf": [ { "$ref": "#\/components\/schemas\/billingLimits" @@ -86735,13 +86681,13 @@ "oAuth2ServerEnabled": { "type": "boolean", "description": "OAuth2 server status", - "x-example": false, + "example": false, "nullable": true }, "oAuth2ServerAuthorizationUrl": { "type": "string", "description": "OAuth2 server authorization URL", - "x-example": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration", + "example": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration", "nullable": true }, "oAuth2ServerScopes": { @@ -86750,7 +86696,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read", "write" ], @@ -86762,7 +86708,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "read" ], "nullable": true @@ -86773,7 +86719,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "project:all" ], "nullable": true @@ -86784,7 +86730,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "calendar" ], "nullable": true @@ -86792,74 +86738,74 @@ "oAuth2ServerAccessTokenDuration": { "type": "integer", "description": "OAuth2 server access token duration in seconds for confidential clients", - "x-example": 3600, "format": "int32", + "example": 3600, "nullable": true }, "oAuth2ServerRefreshTokenDuration": { "type": "integer", "description": "OAuth2 server refresh token duration in seconds for confidential clients", - "x-example": 86400, "format": "int32", + "example": 86400, "nullable": true }, "oAuth2ServerPublicAccessTokenDuration": { "type": "integer", "description": "OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)", - "x-example": 3600, "format": "int32", + "example": 3600, "nullable": true }, "oAuth2ServerPublicRefreshTokenDuration": { "type": "integer", "description": "OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)", - "x-example": 2592000, "format": "int32", + "example": 2592000, "nullable": true }, "oAuth2ServerInstallationAccessTokenDuration": { "type": "integer", "description": "OAuth2 server access token duration in seconds for app installation access tokens", - "x-example": 3600, "format": "int32", + "example": 3600, "nullable": true }, "oAuth2ServerConfidentialPkce": { "type": "boolean", "description": "When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.", - "x-example": false, + "example": false, "nullable": true }, "oAuth2ServerVerificationUrl": { "type": "string", "description": "URL to your application page where users enter the device flow user code. Empty when the Device Authorization Grant is not configured.", - "x-example": "https:\/\/cloud.appwrite.io\/device", + "example": "https:\/\/cloud.appwrite.io\/device", "nullable": true }, "oAuth2ServerUserCodeLength": { "type": "integer", "description": "Number of characters in the device flow user code, excluding the formatting separator.", - "x-example": 8, "format": "int32", + "example": 8, "nullable": true }, "oAuth2ServerUserCodeFormat": { "type": "string", "description": "Character set for device flow user codes: `numeric`, `alphabetic`, or `alphanumeric`.", - "x-example": "alphanumeric", + "example": "alphanumeric", "nullable": true }, "oAuth2ServerDeviceCodeDuration": { "type": "integer", "description": "Lifetime in seconds of device flow device codes and user codes.", - "x-example": 600, "format": "int32", + "example": 600, "nullable": true }, "oAuth2ServerDiscoveryUrl": { "type": "string", "description": "OAuth2 server discovery URL", - "x-example": "https:\/\/auth.example.com\/.well-known\/openid-configuration", + "example": "https:\/\/auth.example.com\/.well-known\/openid-configuration", "nullable": true } }, @@ -86960,7 +86906,7 @@ "$id": { "type": "string", "description": "Auth method ID.", - "x-example": "email-password", + "example": "email-password", "enum": [ "email-password", "magic-url", @@ -86975,7 +86921,7 @@ "enabled": { "type": "boolean", "description": "Auth method status.", - "x-example": false + "example": false } }, "required": [ @@ -86994,7 +86940,7 @@ "$id": { "type": "string", "description": "Service ID.", - "x-example": "sites", + "example": "sites", "enum": [ "account", "avatars", @@ -87020,7 +86966,7 @@ "enabled": { "type": "boolean", "description": "Service status.", - "x-example": false + "example": false } }, "required": [ @@ -87039,7 +86985,7 @@ "$id": { "type": "string", "description": "Protocol ID.", - "x-example": "graphql", + "example": "graphql", "enum": [ "rest", "graphql", @@ -87050,7 +86996,7 @@ "enabled": { "type": "boolean", "description": "Protocol status.", - "x-example": false + "example": false } }, "required": [ @@ -87069,27 +87015,27 @@ "$id": { "type": "string", "description": "Webhook ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Webhook creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Webhook update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Webhook name.", - "x-example": "My Webhook" + "example": "My Webhook" }, "url": { "type": "string", "description": "Webhook URL endpoint.", - "x-example": "https:\/\/example.com\/webhook" + "example": "https:\/\/example.com\/webhook" }, "events": { "type": "array", @@ -87097,7 +87043,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "databases.tables.update", "databases.collections.update" ] @@ -87105,39 +87051,39 @@ "tls": { "type": "boolean", "description": "Indicates if SSL \/ TLS certificate verification is enabled.", - "x-example": true + "example": true }, "authUsername": { "type": "string", "description": "HTTP basic authentication username.", - "x-example": "username" + "example": "username" }, "authPassword": { "type": "string", "description": "HTTP basic authentication password.", - "x-example": "webhook-password", - "format": "password" + "format": "password", + "example": "webhook-password" }, "secret": { "type": "string", "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", - "x-example": "ad3d581ca230e2b7059c545e5a" + "example": "ad3d581ca230e2b7059c545e5a" }, "enabled": { "type": "boolean", "description": "Indicates if this webhook is enabled.", - "x-example": true + "example": true }, "logs": { "type": "string", "description": "Webhook error logs from the most recent failure.", - "x-example": "Failed to connect to remote server." + "example": "Failed to connect to remote server." }, "attempts": { "type": "integer", "description": "Number of consecutive failed webhook attempts.", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 } }, "required": [ @@ -87181,27 +87127,27 @@ "$id": { "type": "string", "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Key name.", - "x-example": "My API Key" + "example": "My API Key" }, "expire": { "type": "string", "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "scopes": { "type": "array", @@ -87209,17 +87155,19 @@ "items": { "type": "string" }, - "x-example": "users.read" + "example": [ + "users.read" + ] }, "secret": { "type": "string", "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "example": "919c2d18fb5d4...a2ae413da83346ad2" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "sdks": { "type": "array", @@ -87227,7 +87175,9 @@ "items": { "type": "string" }, - "x-example": "appwrite:flutter" + "example": [ + "appwrite:flutter" + ] } }, "required": [ @@ -87260,27 +87210,27 @@ "$id": { "type": "string", "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Key name.", - "x-example": "My API Key" + "example": "My API Key" }, "expire": { "type": "string", "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "scopes": { "type": "array", @@ -87288,17 +87238,19 @@ "items": { "type": "string" }, - "x-example": "users.read" + "example": [ + "users.read" + ] }, "secret": { "type": "string", "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "example": "919c2d18fb5d4...a2ae413da83346ad2" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "sdks": { "type": "array", @@ -87306,7 +87258,9 @@ "items": { "type": "string" }, - "x-example": "appwrite:flutter" + "example": [ + "appwrite:flutter" + ] } }, "required": [ @@ -87339,37 +87293,37 @@ "$id": { "type": "string", "description": "Key ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Key creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Key update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Key name.", - "x-example": "Dev API Key" + "example": "Dev API Key" }, "expire": { "type": "string", "description": "Key expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "secret": { "type": "string", "description": "Secret key.", - "x-example": "919c2d18fb5d4...a2ae413da83346ad2" + "example": "919c2d18fb5d4...a2ae413da83346ad2" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "sdks": { "type": "array", @@ -87377,7 +87331,9 @@ "items": { "type": "string" }, - "x-example": "appwrite:flutter" + "example": [ + "appwrite:flutter" + ] } }, "required": [ @@ -87408,22 +87364,22 @@ "number": { "type": "string", "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", - "x-example": "+1612842323" + "example": "+1612842323" }, "otp": { "type": "string", "description": "Mock OTP for the number. ", - "x-example": "123456" + "example": "123456" }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -87446,22 +87402,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "GitHub OAuth2 client ID. For GitHub Apps, use the \"App ID\" when both an App ID and client ID are available.", - "x-example": "e4d87900000000540733" + "example": "e4d87900000000540733" }, "clientSecret": { "type": "string", "description": "GitHub OAuth2 client secret.", - "x-example": "5e07c00000000000000000000000000000198bcc" + "example": "5e07c00000000000000000000000000000198bcc" } }, "required": [ @@ -87484,22 +87440,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Discord OAuth2 client ID.", - "x-example": "950722000000343754" + "example": "950722000000343754" }, "clientSecret": { "type": "string", "description": "Discord OAuth2 client secret.", - "x-example": "YmPXnM000000000000000000002zFg5D" + "example": "YmPXnM000000000000000000002zFg5D" } }, "required": [ @@ -87522,22 +87478,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Figma OAuth2 client ID.", - "x-example": "byay5H0000000000VtiI40" + "example": "byay5H0000000000VtiI40" }, "clientSecret": { "type": "string", "description": "Figma OAuth2 client secret.", - "x-example": "yEpOYn0000000000000000004iIsU5" + "example": "yEpOYn0000000000000000004iIsU5" } }, "required": [ @@ -87560,22 +87516,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "appKey": { "type": "string", "description": "Dropbox OAuth2 app key.", - "x-example": "jl000000000009t" + "example": "jl000000000009t" }, "appSecret": { "type": "string", "description": "Dropbox OAuth2 app secret.", - "x-example": "g200000000000vw" + "example": "g200000000000vw" } }, "required": [ @@ -87598,22 +87554,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "apiKey": { "type": "string", "description": "Dailymotion OAuth2 API key.", - "x-example": "07a9000000000000067f" + "example": "07a9000000000000067f" }, "apiSecret": { "type": "string", "description": "Dailymotion OAuth2 API secret.", - "x-example": "a399a90000000000000000000000000000d90639" + "example": "a399a90000000000000000000000000000d90639" } }, "required": [ @@ -87636,22 +87592,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "key": { "type": "string", "description": "Bitbucket OAuth2 key.", - "x-example": "Knt70000000000ByRc" + "example": "Knt70000000000ByRc" }, "secret": { "type": "string", "description": "Bitbucket OAuth2 secret.", - "x-example": "NMfLZJ00000000000000000000TLQdDx" + "example": "NMfLZJ00000000000000000000TLQdDx" } }, "required": [ @@ -87674,22 +87630,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Bitly OAuth2 client ID.", - "x-example": "d95151000000000000000000000000000067af9b" + "example": "d95151000000000000000000000000000067af9b" }, "clientSecret": { "type": "string", "description": "Bitly OAuth2 client secret.", - "x-example": "a13e250000000000000000000000000000d73095" + "example": "a13e250000000000000000000000000000d73095" } }, "required": [ @@ -87712,22 +87668,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Box OAuth2 client ID.", - "x-example": "deglcs00000000000000000000x2og6y" + "example": "deglcs00000000000000000000x2og6y" }, "clientSecret": { "type": "string", "description": "Box OAuth2 client secret.", - "x-example": "OKM1f100000000000000000000eshEif" + "example": "OKM1f100000000000000000000eshEif" } }, "required": [ @@ -87750,22 +87706,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Autodesk OAuth2 client ID.", - "x-example": "5zw90v00000000000000000000kVYXN7" + "example": "5zw90v00000000000000000000kVYXN7" }, "clientSecret": { "type": "string", "description": "Autodesk OAuth2 client secret.", - "x-example": "7I000000000000MW" + "example": "7I000000000000MW" } }, "required": [ @@ -87788,22 +87744,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Google OAuth2 client ID.", - "x-example": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com" + "example": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com" }, "clientSecret": { "type": "string", "description": "Google OAuth2 client secret.", - "x-example": "GOCSPX-2k8gsR0000000000000000VNahJj" + "example": "GOCSPX-2k8gsR0000000000000000VNahJj" }, "prompt": { "type": "array", @@ -87816,7 +87772,7 @@ "select_account" ] }, - "x-example": [ + "example": [ "consent" ] } @@ -87845,22 +87801,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Zoom OAuth2 client ID.", - "x-example": "QMAC00000000000000w0AQ" + "example": "QMAC00000000000000w0AQ" }, "clientSecret": { "type": "string", "description": "Zoom OAuth2 client secret.", - "x-example": "GAWsG4000000000000000000007U01ON" + "example": "GAWsG4000000000000000000007U01ON" } }, "required": [ @@ -87883,22 +87839,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Zoho OAuth2 client ID.", - "x-example": "1000.83C178000000000000000000RPNX0B" + "example": "1000.83C178000000000000000000RPNX0B" }, "clientSecret": { "type": "string", "description": "Zoho OAuth2 client secret.", - "x-example": "fb5cac000000000000000000000000000000a68f6e" + "example": "fb5cac000000000000000000000000000000a68f6e" } }, "required": [ @@ -87921,22 +87877,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Yandex OAuth2 client ID.", - "x-example": "6a8a6a0000000000000000000091483c" + "example": "6a8a6a0000000000000000000091483c" }, "clientSecret": { "type": "string", "description": "Yandex OAuth2 client secret.", - "x-example": "bbf98500000000000000000000c75a63" + "example": "bbf98500000000000000000000c75a63" } }, "required": [ @@ -87959,22 +87915,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "customerKey": { "type": "string", "description": "X OAuth2 customer key.", - "x-example": "slzZV0000000000000NFLaWT" + "example": "slzZV0000000000000NFLaWT" }, "secretKey": { "type": "string", "description": "X OAuth2 secret key.", - "x-example": "tkEPkp00000000000000000000000000000000000000FTxbI9" + "example": "tkEPkp00000000000000000000000000000000000000FTxbI9" } }, "required": [ @@ -87997,22 +87953,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "WordPress OAuth2 client ID.", - "x-example": "130005" + "example": "130005" }, "clientSecret": { "type": "string", "description": "WordPress OAuth2 client secret.", - "x-example": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" + "example": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" } }, "required": [ @@ -88035,22 +87991,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Twitch OAuth2 client ID.", - "x-example": "vvi0in000000000000000000ikmt9p" + "example": "vvi0in000000000000000000ikmt9p" }, "clientSecret": { "type": "string", "description": "Twitch OAuth2 client secret.", - "x-example": "pmapue000000000000000000zylw3v" + "example": "pmapue000000000000000000zylw3v" } }, "required": [ @@ -88073,22 +88029,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Stripe OAuth2 client ID.", - "x-example": "ca_UKibXX0000000000000000000006byvR" + "example": "ca_UKibXX0000000000000000000006byvR" }, "apiSecretKey": { "type": "string", "description": "Stripe OAuth2 API secret key.", - "x-example": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + "example": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" } }, "required": [ @@ -88111,22 +88067,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Spotify OAuth2 client ID.", - "x-example": "6ec271000000000000000000009beace" + "example": "6ec271000000000000000000009beace" }, "clientSecret": { "type": "string", "description": "Spotify OAuth2 client secret.", - "x-example": "db068a000000000000000000008b5b9f" + "example": "db068a000000000000000000008b5b9f" } }, "required": [ @@ -88149,22 +88105,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Slack OAuth2 client ID.", - "x-example": "23000000089.15000000000023" + "example": "23000000089.15000000000023" }, "clientSecret": { "type": "string", "description": "Slack OAuth2 client secret.", - "x-example": "81656000000000000000000000f3d2fd" + "example": "81656000000000000000000000f3d2fd" } }, "required": [ @@ -88187,22 +88143,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Podio OAuth2 client ID.", - "x-example": "appwrite-oauth-test-app" + "example": "appwrite-oauth-test-app" }, "clientSecret": { "type": "string", "description": "Podio OAuth2 client secret.", - "x-example": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + "example": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" } }, "required": [ @@ -88225,22 +88181,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "oauthClientId": { "type": "string", "description": "Notion OAuth2 client ID.", - "x-example": "341d8700-0000-0000-0000-000000446ee3" + "example": "341d8700-0000-0000-0000-000000446ee3" }, "oauthClientSecret": { "type": "string", "description": "Notion OAuth2 client secret.", - "x-example": "secret_dLUr4b000000000000000000000000000000lFHAa9" + "example": "secret_dLUr4b000000000000000000000000000000lFHAa9" } }, "required": [ @@ -88263,22 +88219,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "customerKey": { "type": "string", "description": "Salesforce OAuth2 consumer key.", - "x-example": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq" + "example": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq" }, "customerSecret": { "type": "string", "description": "Salesforce OAuth2 consumer secret.", - "x-example": "3w000000000000e2" + "example": "3w000000000000e2" } }, "required": [ @@ -88301,22 +88257,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Yahoo OAuth2 client ID.", - "x-example": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm" + "example": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm" }, "clientSecret": { "type": "string", "description": "Yahoo OAuth2 client secret.", - "x-example": "cf978f0000000000000000000000000000c5e2e9" + "example": "cf978f0000000000000000000000000000c5e2e9" } }, "required": [ @@ -88339,22 +88295,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "LinkedIn OAuth2 client ID.", - "x-example": "770000000000dv" + "example": "770000000000dv" }, "primaryClientSecret": { "type": "string", "description": "LinkedIn OAuth2 primary client secret.", - "x-example": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + "example": "WPL_AP1.2Bf0000000000000.\/HtlYw==" } }, "required": [ @@ -88377,22 +88333,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "publicKey": { "type": "string", "description": "Disqus OAuth2 public key.", - "x-example": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX" + "example": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX" }, "secretKey": { "type": "string", "description": "Disqus OAuth2 secret key.", - "x-example": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + "example": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" } }, "required": [ @@ -88415,22 +88371,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Amazon OAuth2 client ID.", - "x-example": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2" + "example": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2" }, "clientSecret": { "type": "string", "description": "Amazon OAuth2 client secret.", - "x-example": "79ffe4000000000000000000000000000000000000000000000000000002de55" + "example": "79ffe4000000000000000000000000000000000000000000000000000002de55" } }, "required": [ @@ -88453,22 +88409,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "keyString": { "type": "string", "description": "Etsy OAuth2 keystring.", - "x-example": "nsgzxh0000000000008j85a2" + "example": "nsgzxh0000000000008j85a2" }, "sharedSecret": { "type": "string", "description": "Etsy OAuth2 shared secret.", - "x-example": "tp000000ru" + "example": "tp000000ru" } }, "required": [ @@ -88491,22 +88447,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "appId": { "type": "string", "description": "Facebook OAuth2 app ID.", - "x-example": "260600000007694" + "example": "260600000007694" }, "appSecret": { "type": "string", "description": "Facebook OAuth2 app secret.", - "x-example": "2d0b2800000000000000000000d38af4" + "example": "2d0b2800000000000000000000d38af4" } }, "required": [ @@ -88529,22 +88485,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "oauth2ClientId": { "type": "string", "description": "Tradeshift OAuth2 client ID.", - "x-example": "appwrite-test-org.appwrite-test-app" + "example": "appwrite-test-org.appwrite-test-app" }, "oauth2ClientSecret": { "type": "string", "description": "Tradeshift OAuth2 client secret.", - "x-example": "7cb52700-0000-0000-0000-000000ca5b83" + "example": "7cb52700-0000-0000-0000-000000ca5b83" } }, "required": [ @@ -88567,22 +88523,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "PayPal OAuth2 client ID.", - "x-example": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB" + "example": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB" }, "secretKey": { "type": "string", "description": "PayPal OAuth2 secret key.", - "x-example": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + "example": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" } }, "required": [ @@ -88605,27 +88561,27 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "applicationId": { "type": "string", "description": "GitLab OAuth2 application ID.", - "x-example": "d41ffe0000000000000000000000000000000000000000000000000000d5e252" + "example": "d41ffe0000000000000000000000000000000000000000000000000000d5e252" }, "secret": { "type": "string", "description": "GitLab OAuth2 secret.", - "x-example": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38" + "example": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38" }, "endpoint": { "type": "string", "description": "GitLab OAuth2 endpoint URL. Defaults to https:\/\/gitlab.com for self-hosted instances.", - "x-example": "https:\/\/gitlab.com" + "example": "https:\/\/gitlab.com" } }, "required": [ @@ -88650,22 +88606,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Appwrite OAuth2 client ID.", - "x-example": "6a42000000000000b5a0" + "example": "6a42000000000000b5a0" }, "clientSecret": { "type": "string", "description": "Appwrite OAuth2 client secret.", - "x-example": "b86afd000000000000000000000000000000000000000000000000000ced5f93" + "example": "b86afd000000000000000000000000000000000000000000000000000ced5f93" } }, "required": [ @@ -88688,27 +88644,27 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Authentik OAuth2 client ID.", - "x-example": "dTKOPa0000000000000000000000000000e7G8hv" + "example": "dTKOPa0000000000000000000000000000e7G8hv" }, "clientSecret": { "type": "string", "description": "Authentik OAuth2 client secret.", - "x-example": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK" + "example": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK" }, "endpoint": { "type": "string", "description": "Authentik OAuth2 endpoint domain.", - "x-example": "example.authentik.com" + "example": "example.authentik.com" } }, "required": [ @@ -88733,27 +88689,27 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Auth0 OAuth2 client ID.", - "x-example": "OaOkIA000000000000000000005KLSYq" + "example": "OaOkIA000000000000000000005KLSYq" }, "clientSecret": { "type": "string", "description": "Auth0 OAuth2 client secret.", - "x-example": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF" + "example": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF" }, "endpoint": { "type": "string", "description": "Auth0 OAuth2 endpoint domain.", - "x-example": "example.us.auth0.com" + "example": "example.us.auth0.com" } }, "required": [ @@ -88778,27 +88734,27 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "FusionAuth OAuth2 client ID.", - "x-example": "b2222c00-0000-0000-0000-000000862097" + "example": "b2222c00-0000-0000-0000-000000862097" }, "clientSecret": { "type": "string", "description": "FusionAuth OAuth2 client secret.", - "x-example": "Jx4s0C0000000000000000000000000000000wGqLsc" + "example": "Jx4s0C0000000000000000000000000000000wGqLsc" }, "endpoint": { "type": "string", "description": "FusionAuth OAuth2 endpoint domain.", - "x-example": "example.fusionauth.io" + "example": "example.fusionauth.io" } }, "required": [ @@ -88823,32 +88779,32 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Keycloak OAuth2 client ID.", - "x-example": "appwrite-o0000000st-app" + "example": "appwrite-o0000000st-app" }, "clientSecret": { "type": "string", "description": "Keycloak OAuth2 client secret.", - "x-example": "jdjrJd00000000000000000000HUsaZO" + "example": "jdjrJd00000000000000000000HUsaZO" }, "endpoint": { "type": "string", "description": "Keycloak OAuth2 endpoint domain.", - "x-example": "keycloak.example.com" + "example": "keycloak.example.com" }, "realmName": { "type": "string", "description": "Keycloak OAuth2 realm name.", - "x-example": "appwrite-realm" + "example": "appwrite-realm" } }, "required": [ @@ -88875,42 +88831,42 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "OpenID Connect OAuth2 client ID.", - "x-example": "qibI2x0000000000000000000000000006L2YFoG" + "example": "qibI2x0000000000000000000000000006L2YFoG" }, "clientSecret": { "type": "string", "description": "OpenID Connect OAuth2 client secret.", - "x-example": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV" + "example": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV" }, "wellKnownURL": { "type": "string", "description": "OpenID Connect well-known configuration URL. When set, authorization, token, and user info endpoints can be discovered automatically.", - "x-example": "https:\/\/myoauth.com\/.well-known\/openid-configuration" + "example": "https:\/\/myoauth.com\/.well-known\/openid-configuration" }, "authorizationURL": { "type": "string", "description": "OpenID Connect authorization endpoint URL.", - "x-example": "https:\/\/myoauth.com\/oauth2\/authorize" + "example": "https:\/\/myoauth.com\/oauth2\/authorize" }, "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL.", - "x-example": "https:\/\/myoauth.com\/oauth2\/token" + "example": "https:\/\/myoauth.com\/oauth2\/token" }, "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL.", - "x-example": "https:\/\/myoauth.com\/oauth2\/userinfo" + "example": "https:\/\/myoauth.com\/oauth2\/userinfo" }, "prompt": { "type": "array", @@ -88924,15 +88880,15 @@ "select_account" ] }, - "x-example": [ + "example": [ "consent" ] }, "maxAge": { "type": "integer", "description": "Maximum authentication age in seconds. When set, the user must have authenticated within this many seconds.", - "x-example": 3600, "format": "int32", + "example": 3600, "nullable": true } }, @@ -88969,32 +88925,32 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Okta OAuth2 client ID.", - "x-example": "0oa00000000000000698" + "example": "0oa00000000000000698" }, "clientSecret": { "type": "string", "description": "Okta OAuth2 client secret.", - "x-example": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV" + "example": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV" }, "domain": { "type": "string", "description": "Okta OAuth2 domain.", - "x-example": "trial-6400025.okta.com" + "example": "trial-6400025.okta.com" }, "authorizationServerId": { "type": "string", "description": "Okta OAuth2 authorization server ID.", - "x-example": "aus000000000000000h7z" + "example": "aus000000000000000h7z" } }, "required": [ @@ -89021,22 +88977,22 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "clientId": { "type": "string", "description": "Kick OAuth2 client ID.", - "x-example": "01KQ7C00000000000001MFHS32" + "example": "01KQ7C00000000000001MFHS32" }, "clientSecret": { "type": "string", "description": "Kick OAuth2 client secret.", - "x-example": "34ac5600000000000000000000000000000000000000000000000000e830c8b" + "example": "34ac5600000000000000000000000000000000000000000000000000e830c8b" } }, "required": [ @@ -89059,32 +89015,32 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "apple" + "example": "apple" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "serviceId": { "type": "string", "description": "Apple OAuth2 service ID.", - "x-example": "ip.appwrite.app.web" + "example": "ip.appwrite.app.web" }, "keyId": { "type": "string", "description": "Apple OAuth2 key ID.", - "x-example": "P4000000N8" + "example": "P4000000N8" }, "teamId": { "type": "string", "description": "Apple OAuth2 team ID.", - "x-example": "D4000000R6" + "example": "D4000000R6" }, "p8File": { "type": "string", "description": "Apple OAuth2 .p8 private key file contents. The secret key wrapped by the PEM markers is 200 characters long.", - "x-example": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" + "example": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" } }, "required": [ @@ -89111,27 +89067,27 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "x-example": "github" + "example": "github" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "x-example": false + "example": false }, "applicationId": { "type": "string", "description": "Microsoft OAuth2 application ID.", - "x-example": "00001111-aaaa-2222-bbbb-3333cccc4444" + "example": "00001111-aaaa-2222-bbbb-3333cccc4444" }, "applicationSecret": { "type": "string", "description": "Microsoft OAuth2 application secret.", - "x-example": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u" + "example": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u" }, "tenant": { "type": "string", "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID.", - "x-example": "common" + "example": "common" } }, "required": [ @@ -89156,8 +89112,8 @@ "total": { "type": "integer", "description": "Total number of OAuth2 providers in the given project.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "providers": { "type": "array", @@ -89336,8 +89292,7 @@ "microsoft": "#\/components\/schemas\/oAuth2Microsoft" } } - }, - "x-example": "" + } } }, "required": [ @@ -89356,12 +89311,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether password dictionary policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -89380,13 +89335,13 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "total": { "type": "integer", "description": "Password history length. A value of 0 means the policy is disabled.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 } }, "required": [ @@ -89405,33 +89360,33 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "min": { "type": "integer", "description": "Minimum password length required for user passwords.", - "x-example": 12, - "format": "int32" + "format": "int32", + "example": 12 }, "uppercase": { "type": "boolean", "description": "Whether passwords must include at least one uppercase letter.", - "x-example": true + "example": true }, "lowercase": { "type": "boolean", "description": "Whether passwords must include at least one lowercase letter.", - "x-example": true + "example": true }, "number": { "type": "boolean", "description": "Whether passwords must include at least one number.", - "x-example": true + "example": true }, "symbols": { "type": "boolean", "description": "Whether passwords must include at least one symbol.", - "x-example": true + "example": true } }, "required": [ @@ -89458,12 +89413,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether password personal data policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -89482,12 +89437,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether session alert policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -89506,13 +89461,13 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "duration": { "type": "integer", "description": "Session duration in seconds.", - "x-example": 3600, - "format": "int32" + "format": "int32", + "example": 3600 } }, "required": [ @@ -89531,12 +89486,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether session invalidation policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -89555,13 +89510,13 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "total": { "type": "integer", "description": "Maximum number of sessions allowed per user. A value of 0 means the policy is disabled.", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 } }, "required": [ @@ -89580,13 +89535,13 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "total": { "type": "integer", "description": "Maximum number of users allowed in the project. A value of 0 means the policy is disabled.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 } }, "required": [ @@ -89605,37 +89560,37 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "userId": { "type": "boolean", "description": "Whether user ID is visible in memberships.", - "x-example": true + "example": true }, "userEmail": { "type": "boolean", "description": "Whether user email is visible in memberships.", - "x-example": true + "example": true }, "userPhone": { "type": "boolean", "description": "Whether user phone is visible in memberships.", - "x-example": true + "example": true }, "userName": { "type": "boolean", "description": "Whether user name is visible in memberships.", - "x-example": true + "example": true }, "userMFA": { "type": "boolean", "description": "Whether user MFA status is visible in memberships.", - "x-example": true + "example": true }, "userAccessedAt": { "type": "boolean", "description": "Whether user last access time is visible in memberships.", - "x-example": true + "example": true } }, "required": [ @@ -89664,27 +89619,27 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "totp": { "type": "boolean", "description": "Whether TOTP can be used to complete an MFA challenge.", - "x-example": true + "example": true }, "email": { "type": "boolean", "description": "Whether email can be used to complete an MFA challenge.", - "x-example": true + "example": true }, "phone": { "type": "boolean", "description": "Whether phone (SMS) can be used to complete an MFA challenge.", - "x-example": true + "example": true }, "custom": { "type": "boolean", "description": "Whether the custom factor can be used to complete an MFA challenge.", - "x-example": true + "example": true } }, "required": [ @@ -89709,27 +89664,27 @@ "$id": { "type": "string", "description": "Platform ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Platform name.", - "x-example": "My Web App" + "example": "My Web App" }, "type": { "type": "string", "description": "Platform type. Possible values are: windows, apple, android, linux, web.", - "x-example": "web", + "example": "web", "enum": [ "windows", "apple", @@ -89742,7 +89697,7 @@ "hostname": { "type": "string", "description": "Web app hostname. Empty string for other platforms.", - "x-example": "app.example.com" + "example": "app.example.com" } }, "required": [ @@ -89770,27 +89725,27 @@ "$id": { "type": "string", "description": "Platform ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Platform name.", - "x-example": "My Web App" + "example": "My Web App" }, "type": { "type": "string", "description": "Platform type. Possible values are: windows, apple, android, linux, web.", - "x-example": "web", + "example": "web", "enum": [ "windows", "apple", @@ -89803,7 +89758,7 @@ "bundleIdentifier": { "type": "string", "description": "Apple bundle identifier.", - "x-example": "com.company.appname" + "example": "com.company.appname" } }, "required": [ @@ -89830,27 +89785,27 @@ "$id": { "type": "string", "description": "Platform ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Platform name.", - "x-example": "My Web App" + "example": "My Web App" }, "type": { "type": "string", "description": "Platform type. Possible values are: windows, apple, android, linux, web.", - "x-example": "web", + "example": "web", "enum": [ "windows", "apple", @@ -89863,7 +89818,7 @@ "applicationId": { "type": "string", "description": "Android application ID.", - "x-example": "com.company.appname" + "example": "com.company.appname" } }, "required": [ @@ -89890,27 +89845,27 @@ "$id": { "type": "string", "description": "Platform ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Platform name.", - "x-example": "My Web App" + "example": "My Web App" }, "type": { "type": "string", "description": "Platform type. Possible values are: windows, apple, android, linux, web.", - "x-example": "web", + "example": "web", "enum": [ "windows", "apple", @@ -89923,7 +89878,7 @@ "packageIdentifierName": { "type": "string", "description": "Windows package identifier name.", - "x-example": "com.company.appname" + "example": "com.company.appname" } }, "required": [ @@ -89950,27 +89905,27 @@ "$id": { "type": "string", "description": "Platform ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Platform name.", - "x-example": "My Web App" + "example": "My Web App" }, "type": { "type": "string", "description": "Platform type. Possible values are: windows, apple, android, linux, web.", - "x-example": "web", + "example": "web", "enum": [ "windows", "apple", @@ -89983,7 +89938,7 @@ "packageName": { "type": "string", "description": "Linux package name.", - "x-example": "com.company.appname" + "example": "com.company.appname" } }, "required": [ @@ -90010,8 +89965,8 @@ "total": { "type": "integer", "description": "Total number of platforms in the given project.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "platforms": { "type": "array", @@ -90044,8 +89999,7 @@ "linux": "#\/components\/schemas\/platformLinux" } } - }, - "x-example": "" + } } }, "required": [ @@ -90064,42 +90018,42 @@ "$id": { "type": "string", "description": "Variable ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Variable creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Variable creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "key": { "type": "string", "description": "Variable key.", - "x-example": "API_KEY" + "example": "API_KEY" }, "value": { "type": "string", "description": "Variable value.", - "x-example": "myPa$$word1" + "example": "myPa$$word1" }, "secret": { "type": "boolean", "description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.", - "x-example": false + "example": false }, "resourceType": { "type": "string", "description": "Service to which the variable belongs. Possible values are \"project\", \"function\"", - "x-example": "function" + "example": "function" }, "resourceId": { "type": "string", "description": "ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.", - "x-example": "myAwesomeFunction" + "example": "myAwesomeFunction" } }, "required": [ @@ -90130,12 +90084,12 @@ "name": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" }, "code": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" } }, "required": [ @@ -90154,12 +90108,12 @@ "name": { "type": "string", "description": "Continent name.", - "x-example": "Europe" + "example": "Europe" }, "code": { "type": "string", "description": "Continent two letter code.", - "x-example": "EU" + "example": "EU" } }, "required": [ @@ -90178,17 +90132,17 @@ "name": { "type": "string", "description": "Language name.", - "x-example": "Italian" + "example": "Italian" }, "code": { "type": "string", "description": "Language two-character ISO 639-1 codes.", - "x-example": "it" + "example": "it" }, "nativeName": { "type": "string", "description": "Language native name.", - "x-example": "Italiano" + "example": "Italiano" } }, "required": [ @@ -90209,39 +90163,39 @@ "symbol": { "type": "string", "description": "Currency symbol.", - "x-example": "$" + "example": "$" }, "name": { "type": "string", "description": "Currency name.", - "x-example": "US dollar" + "example": "US dollar" }, "symbolNative": { "type": "string", "description": "Currency native symbol.", - "x-example": "$" + "example": "$" }, "decimalDigits": { "type": "integer", "description": "Number of decimal digits.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "rounding": { "type": "number", "description": "Currency digit rounding.", - "x-example": 0, - "format": "double" + "format": "double", + "example": 0 }, "code": { "type": "string", "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.", - "x-example": "USD" + "example": "USD" }, "namePlural": { "type": "string", "description": "Currency plural name", - "x-example": "US dollars" + "example": "US dollars" } }, "required": [ @@ -90270,17 +90224,17 @@ "code": { "type": "string", "description": "Phone code.", - "x-example": "+1" + "example": "+1" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "x-example": "US" + "example": "US" }, "countryName": { "type": "string", "description": "Country name.", - "x-example": "United States" + "example": "United States" } }, "required": [ @@ -90301,12 +90255,12 @@ "name": { "type": "string", "description": "Header name.", - "x-example": "Content-Type" + "example": "Content-Type" }, "value": { "type": "string", "description": "Header value.", - "x-example": "application\/json" + "example": "application\/json" } }, "required": [ @@ -90325,24 +90279,24 @@ "memory": { "type": "integer", "description": "Memory size in MB.", - "x-example": 512, - "format": "int32" + "format": "int32", + "example": 512 }, "cpus": { "type": "number", "description": "Number of CPUs.", - "x-example": 1, - "format": "double" + "format": "double", + "example": 1 }, "enabled": { "type": "boolean", "description": "Is size enabled.", - "x-example": true + "example": true }, "slug": { "type": "string", "description": "Size slug.", - "x-example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb" } }, "required": [ @@ -90365,53 +90319,53 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Rule creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Rule update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "domain": { "type": "string", "description": "Domain name.", - "x-example": "appwrite.company.com" + "example": "appwrite.company.com" }, "type": { "type": "string", "description": "Action definition for the rule. Possible values are \"api\", \"deployment\", or \"redirect\"", - "x-example": "deployment" + "example": "deployment" }, "trigger": { "type": "string", "description": "Defines how the rule was created. Possible values are \"manual\" or \"deployment\"", - "x-example": "manual" + "example": "manual" }, "redirectUrl": { "type": "string", "description": "URL to redirect to. Used if type is \"redirect\"", - "x-example": "https:\/\/appwrite.io\/docs" + "example": "https:\/\/appwrite.io\/docs" }, "redirectStatusCode": { "type": "integer", "description": "Status code to apply during redirect. Used if type is \"redirect\"", - "x-example": 301, - "format": "int32" + "format": "int32", + "example": 301 }, "deploymentId": { "type": "string", "description": "ID of deployment. Used if type is \"deployment\"", - "x-example": "n3u9feiwmf" + "example": "n3u9feiwmf" }, "deploymentResourceType": { "type": "string", "description": "Type of deployment. Possible values are \"function\", \"site\". Used if rule's type is \"deployment\".", - "x-example": "function", + "example": "function", "enum": [ "function", "site" @@ -90421,17 +90375,17 @@ "deploymentResourceId": { "type": "string", "description": "ID of deployment's resource (site or function ID). Used if type is \"deployment\"", - "x-example": "n3u9feiwmf" + "example": "n3u9feiwmf" }, "deploymentVcsProviderBranch": { "type": "string", "description": "Name of Git branch that updates rule. Used if type is \"deployment\"", - "x-example": "main" + "example": "main" }, "status": { "type": "string", "description": "Domain verification status. Possible values are \"unverified\", \"verifying\", \"verified\"", - "x-example": "verified", + "example": "verified", "enum": [ "unverified", "verifying", @@ -90441,12 +90395,12 @@ "logs": { "type": "string", "description": "Logs from rule verification or certificate generation. Certificate generation logs are prioritized if both are available.", - "x-example": "Verification of DNS records failed with DNS resolver 8.8.8.8. Domain stage.myapp.com does not have DNS record." + "example": "Verification of DNS records failed with DNS resolver 8.8.8.8. Domain stage.myapp.com does not have DNS record." }, "renewAt": { "type": "string", "description": "Certificate auto-renewal date in ISO 8601 format.", - "x-example": "datetime" + "example": "datetime" } }, "required": [ @@ -90490,42 +90444,42 @@ "templateId": { "type": "string", "description": "Template type", - "x-example": "verification" + "example": "verification" }, "locale": { "type": "string", "description": "Template locale", - "x-example": "en_us" + "example": "en_us" }, "message": { "type": "string", "description": "Template message", - "x-example": "Click on the link to verify your account." + "example": "Click on the link to verify your account." }, "senderName": { "type": "string", "description": "Name of the sender", - "x-example": "My User" + "example": "My User" }, "senderEmail": { "type": "string", "description": "Email of the sender", - "x-example": "mail@appwrite.io" + "example": "mail@appwrite.io" }, "replyToEmail": { "type": "string", "description": "Reply to email address", - "x-example": "emails@appwrite.io" + "example": "emails@appwrite.io" }, "replyToName": { "type": "string", "description": "Reply to name", - "x-example": "Support Team" + "example": "Support Team" }, "subject": { "type": "string", "description": "Email subject", - "x-example": "Please verify your email address" + "example": "Please verify your email address" } }, "required": [ @@ -90556,22 +90510,22 @@ "$id": { "type": "string", "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -90594,27 +90548,27 @@ "$id": { "type": "string", "description": "Token ID.", - "x-example": "bb8ea5c16897e" + "example": "bb8ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "code": { "type": "string", "description": "Challenge code to be delivered to the end user through a custom channel.", - "x-example": "446372" + "example": "446372" } }, "required": [ @@ -90642,7 +90596,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "a3kf0-s0cl2", "s0co1-as98s" ] @@ -90665,12 +90619,12 @@ "secret": { "type": "string", "description": "Secret token used for TOTP factor.", - "x-example": "[SHARED_SECRET]" + "example": "[SHARED_SECRET]" }, "uri": { "type": "string", "description": "URI for authenticator apps.", - "x-example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" + "example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" } }, "required": [ @@ -90689,27 +90643,27 @@ "totp": { "type": "boolean", "description": "Can TOTP be used for MFA challenge for this account.", - "x-example": true + "example": true }, "phone": { "type": "boolean", "description": "Can phone (SMS) be used for MFA challenge for this account.", - "x-example": true + "example": true }, "email": { "type": "boolean", "description": "Can email be used for MFA challenge for this account.", - "x-example": true + "example": true }, "recoveryCode": { "type": "boolean", "description": "Can recovery code be used for MFA challenge for this account.", - "x-example": true + "example": true }, "custom": { "type": "boolean", "description": "Can custom factor be used for MFA challenge for this account.", - "x-example": true + "example": true } }, "required": [ @@ -90734,43 +90688,43 @@ "$id": { "type": "string", "description": "Provider ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Provider creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Provider update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "The name for the provider instance.", - "x-example": "Mailgun" + "example": "Mailgun" }, "provider": { "type": "string", "description": "The name of the provider service.", - "x-example": "mailgun" + "example": "mailgun" }, "enabled": { "type": "boolean", "description": "Is provider enabled?", - "x-example": true + "example": true }, "type": { "type": "string", "description": "Type of provider.", - "x-example": "sms" + "example": "sms" }, "credentials": { "type": "object", "additionalProperties": true, "description": "Provider credentials.", - "x-example": { + "example": { "key": "123456789" } }, @@ -90778,7 +90732,7 @@ "type": "object", "additionalProperties": true, "description": "Provider options.", - "x-example": { + "example": { "from": "sender-email@mydomain" } } @@ -90816,22 +90770,22 @@ "$id": { "type": "string", "description": "Message ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Message creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Message update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "providerType": { "type": "string", "description": "Message provider type.", - "x-example": "email" + "example": "email" }, "topics": { "type": "array", @@ -90839,7 +90793,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "5e5ea5c16897e" ] }, @@ -90849,7 +90803,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "5e5ea5c16897e" ] }, @@ -90859,20 +90813,20 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "5e5ea5c16897e" ] }, "scheduledAt": { "type": "string", "description": "The scheduled time for message.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "deliveredAt": { "type": "string", "description": "The time when the message was delivered.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "deliveryErrors": { @@ -90881,7 +90835,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "Failed to send message to target 5e5ea5c16897e: Credentials not valid." ], "nullable": true @@ -90889,14 +90843,14 @@ "deliveredTotal": { "type": "integer", "description": "Number of recipients the message was delivered to.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "data": { "type": "object", "additionalProperties": true, "description": "Data of the message.", - "x-example": { + "example": { "subject": "Welcome to Appwrite", "content": "Hi there, welcome to Appwrite family." } @@ -90904,7 +90858,7 @@ "status": { "type": "string", "description": "Status of delivery.", - "x-example": "processing", + "example": "processing", "enum": [ "draft", "processing", @@ -90960,40 +90914,40 @@ "$id": { "type": "string", "description": "Topic ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Topic creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Topic update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "The name of the topic.", - "x-example": "events" + "example": "events" }, "emailTotal": { "type": "integer", "description": "Total count of email subscribers subscribed to the topic.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "smsTotal": { "type": "integer", "description": "Total count of SMS subscribers subscribed to the topic.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "pushTotal": { "type": "integer", "description": "Total count of push subscribers subscribed to the topic.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "subscribe": { "type": "array", @@ -91001,7 +90955,9 @@ "items": { "type": "string" }, - "x-example": "users" + "example": [ + "users" + ] } }, "required": [ @@ -91032,33 +90988,33 @@ "$id": { "type": "string", "description": "Transaction ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Transaction creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Transaction update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "status": { "type": "string", "description": "Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.", - "x-example": "pending" + "example": "pending" }, "operations": { "type": "integer", "description": "Number of operations in the transaction.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "expiresAt": { "type": "string", "description": "Expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -91085,27 +91041,27 @@ "$id": { "type": "string", "description": "Subscriber ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Subscriber creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Subscriber update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "targetId": { "type": "string", "description": "Target ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "target": { "type": "object", "description": "Target.", - "x-example": { + "example": { "$id": "259125845563242502", "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", @@ -91124,22 +91080,22 @@ "userId": { "type": "string", "description": "Topic ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userName": { "type": "string", "description": "User Name.", - "x-example": "Aegon Targaryen" + "example": "Aegon Targaryen" }, "topicId": { "type": "string", "description": "Topic ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "providerType": { "type": "string", "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email" + "example": "email" } }, "required": [ @@ -91181,48 +91137,48 @@ "$id": { "type": "string", "description": "Target ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "$createdAt": { "type": "string", "description": "Target creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Target update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Target Name.", - "x-example": "Apple iPhone 12" + "example": "Apple iPhone 12" }, "userId": { "type": "string", "description": "User ID.", - "x-example": "259125845563242502" + "example": "259125845563242502" }, "providerId": { "type": "string", "description": "Provider ID.", - "x-example": "259125845563242502", + "example": "259125845563242502", "nullable": true }, "providerType": { "type": "string", "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "x-example": "email" + "example": "email" }, "identifier": { "type": "string", "description": "The target identifier.", - "x-example": "token" + "example": "token" }, "expired": { "type": "boolean", "description": "Is the target expired.", - "x-example": false + "example": false } }, "required": [ @@ -91254,67 +91210,67 @@ "$id": { "type": "string", "description": "Insight ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Insight creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Insight update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "reportId": { "type": "string", "description": "Parent report ID. Insights always belong to a report.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "type": { "type": "string", "description": "Insight type. One of databaseIndex (legacy), tablesDBIndex, documentsDBIndex, vectorsDBIndex, databasePerformance, sitePerformance, siteAccessibility, siteSeo, functionPerformance. The index types are engine-specific so each CTA can pair the right service+method (databases.createIndex, tablesDB.createIndex, documentsDB.createIndex, or vectorsDB.createIndex).", - "x-example": "tablesDBIndex" + "example": "tablesDBIndex" }, "severity": { "type": "string", "description": "Insight severity. One of info, warning, critical.", - "x-example": "warning" + "example": "warning" }, "status": { "type": "string", "description": "Insight status. One of active, dismissed.", - "x-example": "active" + "example": "active" }, "resourceType": { "type": "string", "description": "Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.", - "x-example": "databases" + "example": "databases" }, "resourceId": { "type": "string", "description": "ID of the resource the insight is about.", - "x-example": "main" + "example": "main" }, "parentResourceType": { "type": "string", "description": "Plural noun for the parent resource that contains the insight's resource, e.g. an insight about a column index on a table \u2192 resourceType=indexes, parentResourceType=tables. Empty when the resource has no parent.", - "x-example": "tables" + "example": "tables" }, "parentResourceId": { "type": "string", "description": "ID of the parent resource. Empty when the resource has no parent.", - "x-example": "orders" + "example": "orders" }, "title": { "type": "string", "description": "Insight title.", - "x-example": "Missing index on collection orders" + "example": "Missing index on collection orders" }, "summary": { "type": "string", "description": "Short markdown summary describing the insight.", - "x-example": "Queries against `orders.status` are scanning the full collection." + "example": "Queries against `orders.status` are scanning the full collection." }, "ctas": { "type": "array", @@ -91322,24 +91278,24 @@ "items": { "$ref": "#\/components\/schemas\/insightCTA" }, - "x-example": [] + "example": [] }, "analyzedAt": { "type": "string", "description": "Time the insight was analyzed in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "dismissedAt": { "type": "string", "description": "Time the insight was dismissed in ISO 8601 format. Empty when not dismissed.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "dismissedBy": { "type": "string", "description": "User ID that dismissed the insight. Empty when not dismissed.", - "x-example": "5e5ea5c16897e", + "example": "5e5ea5c16897e", "nullable": true } }, @@ -91386,23 +91342,23 @@ "label": { "type": "string", "description": "Human-readable label for the CTA, used in UI.", - "x-example": "Create missing index" + "example": "Create missing index" }, "service": { "type": "string", "description": "Public API service (SDK namespace) the client should invoke. Must match the engine that owns the resource \u2014 for index suggestions: databases (legacy), tablesDB, documentsDB, or vectorsDB.", - "x-example": "tablesDB" + "example": "tablesDB" }, "method": { "type": "string", "description": "Public API method on the chosen service the client should invoke when this CTA is triggered.", - "x-example": "createIndex" + "example": "createIndex" }, "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": { + "example": { "databaseId": "main", "tableId": "orders", "key": "_idx_status", @@ -91441,47 +91397,47 @@ "$id": { "type": "string", "description": "Report ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Report creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Report update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "ID of the third-party app that submitted the report.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "type": { "type": "string", "description": "Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.", - "x-example": "lighthouse" + "example": "lighthouse" }, "title": { "type": "string", "description": "Short, human-readable title for the report.", - "x-example": "Lighthouse audit for https:\/\/appwrite.io\/" + "example": "Lighthouse audit for https:\/\/appwrite.io\/" }, "summary": { "type": "string", "description": "Markdown summary describing the report.", - "x-example": "Performance score 78. 4 opportunities found." + "example": "Performance score 78. 4 opportunities found." }, "targetType": { "type": "string", "description": "Plural noun describing what the report analyzes, e.g. databases, sites, urls.", - "x-example": "urls" + "example": "urls" }, "target": { "type": "string", "description": "Free-form target identifier (URL for lighthouse, resource ID for db).", - "x-example": "https:\/\/appwrite.io\/" + "example": "https:\/\/appwrite.io\/" }, "categories": { "type": "array", @@ -91489,7 +91445,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "performance", "accessibility" ] @@ -91500,12 +91456,12 @@ "items": { "$ref": "#\/components\/schemas\/insight" }, - "x-example": [] + "example": [] }, "analyzedAt": { "type": "string", "description": "Time the report was analyzed in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -91547,147 +91503,147 @@ "$id": { "type": "string", "description": "Event ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "actorType": { "type": "string", "description": "Actor type.", - "x-example": "user" + "example": "user" }, "actorId": { "type": "string", "description": "Actor ID.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "actorEmail": { "type": "string", "description": "Actor Email.", - "x-example": "john@appwrite.io" + "example": "john@appwrite.io" }, "actorName": { "type": "string", "description": "Actor Name.", - "x-example": "John Doe" + "example": "John Doe" }, "resourceParent": { "type": "string", "description": "Resource parent.", - "x-example": "database\/ID" + "example": "database\/ID" }, "resourceType": { "type": "string", "description": "Resource type.", - "x-example": "collection" + "example": "collection" }, "resourceId": { "type": "string", "description": "Resource ID.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "resource": { "type": "string", "description": "Resource.", - "x-example": "collections\/610fc2f985ee0" + "example": "collections\/610fc2f985ee0" }, "event": { "type": "string", "description": "Event name.", - "x-example": "account.sessions.create" + "example": "account.sessions.create" }, "userAgent": { "type": "string", "description": "User agent.", - "x-example": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/86.0.4240.198 Safari\/537.36" + "example": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/86.0.4240.198 Safari\/537.36" }, "ip": { "type": "string", "description": "IP address.", - "x-example": "127.0.0.1" + "example": "127.0.0.1" }, "mode": { "type": "string", "description": "API mode when event triggered.", - "x-example": "admin" + "example": "admin" }, "country": { "type": "string", "description": "Location.", - "x-example": "US" + "example": "US" }, "continentCode": { "type": "string", "description": "Continent code.", - "x-example": "NA" + "example": "NA" }, "city": { "type": "string", "description": "City name.", - "x-example": "Mountain View" + "example": "Mountain View" }, "subdivisions": { "type": "string", "description": "Region\/state chain.", - "x-example": "California" + "example": "California" }, "isp": { "type": "string", "description": "Internet service provider.", - "x-example": "Google" + "example": "Google" }, "autonomousSystemNumber": { "type": "string", "description": "Autonomous System Number (ASN).", - "x-example": "15169" + "example": "15169" }, "autonomousSystemOrganization": { "type": "string", "description": "Organization that owns the ASN.", - "x-example": "GOOGLE" + "example": "GOOGLE" }, "connectionType": { "type": "string", "description": "Connection type (e.g. cable, cellular, corporate).", - "x-example": "cable" + "example": "cable" }, "connectionUsageType": { "type": "string", "description": "User type (e.g. residential, business, hosting).", - "x-example": "residential" + "example": "residential" }, "connectionOrganization": { "type": "string", "description": "Registered organization of the IP.", - "x-example": "Google LLC" + "example": "Google LLC" }, "time": { "type": "string", "description": "Log creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "610fc2f985ee0" + "example": "610fc2f985ee0" }, "hostname": { "type": "string", "description": "Hostname.", - "x-example": "appwrite.io" + "example": "appwrite.io" }, "sdk": { "type": "string", "description": "Name of the SDK that triggered the event.", - "x-example": "web" + "example": "web" }, "sdkVersion": { "type": "string", "description": "Version of the SDK that triggered the event.", - "x-example": "14.0.0" + "example": "14.0.0" } }, "required": [ @@ -91760,34 +91716,34 @@ "name": { "type": "string", "description": "Resource name", - "x-example": "" + "example": "" }, "unit": { "type": "string", "description": "Resource unit", - "x-example": "GB" + "example": "GB" }, "currency": { "type": "string", "description": "Price currency", - "x-example": "USD" + "example": "USD" }, "price": { "type": "number", "description": "Price", - "x-example": 5, - "format": "double" + "format": "double", + "example": 5 }, "value": { "type": "integer", "description": "Resource value", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "invoiceDesc": { "type": "string", "description": "Description on invoice", - "x-example": "" + "example": "" } }, "required": [ @@ -91814,43 +91770,43 @@ "$id": { "type": "string", "description": "Archive ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Archive creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Archive update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "policyId": { "type": "string", "description": "Archive policy ID.", - "x-example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7" }, "size": { "type": "integer", "description": "Archive size in bytes.", - "x-example": 100000, - "format": "int32" + "format": "int32", + "example": 100000 }, "status": { "type": "string", "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.", - "x-example": "completed" + "example": "completed" }, "startedAt": { "type": "string", "description": "The backup start time.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "migrationId": { "type": "string", "description": "Migration ID.", - "x-example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7" }, "services": { "type": "array", @@ -91858,7 +91814,9 @@ "items": { "type": "string" }, - "x-example": "['databases', 'storage']" + "example": [ + "['databases', 'storage']" + ] }, "resources": { "type": "array", @@ -91866,18 +91824,20 @@ "items": { "type": "string" }, - "x-example": "['databases', 'collections', 'attributes', 'indexes']" + "example": [ + "['databases', 'collections', 'attributes', 'indexes']" + ] }, "resourceId": { "type": "string", "description": "The resource ID to backup. Set only if this archive should backup a single resource.", - "x-example": "DB1", + "example": "DB1", "nullable": true }, "resourceType": { "type": "string", "description": "The resource type to backup. Set only if this archive should backup a single resource.", - "x-example": "database", + "example": "database", "nullable": true } }, @@ -91915,93 +91875,93 @@ "$id": { "type": "string", "description": "Backup ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Backup creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "databaseId": { "type": "string", "description": "Database ID this backup belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "policyId": { "type": "string", "description": "Backup policy ID when the backup was created by a schedule.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "trigger": { "type": "string", "description": "Backup trigger. Possible values: manual, schedule.", - "x-example": "schedule" + "example": "schedule" }, "type": { "type": "string", "description": "Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup), wal (write-ahead log continuous archival).", - "x-example": "full" + "example": "full" }, "requestedType": { "type": "string", "description": "Backup type that was requested. Differs from `type` when the backend could not run the requested type and took a different one instead, in which case `fallbackReason` explains why. Empty for backups taken before the requested type was recorded.", - "x-example": "incremental" + "example": "incremental" }, "fallbackReason": { "type": "string", "description": "Why the backend ran a different backup type than the one requested. Empty when the backup ran as requested.", - "x-example": "PostgreSQL incremental backups are not offered because they cannot be restored: archived WAL is physical and cannot replay onto a logically-restored base. A full backup was taken instead; use a point-in-time restore (targetTime) to recover to a moment between fulls." + "example": "PostgreSQL incremental backups are not offered because they cannot be restored: archived WAL is physical and cannot replay onto a logically-restored base. A full backup was taken instead; use a point-in-time restore (targetTime) to recover to a moment between fulls." }, "status": { "type": "string", "description": "Backup status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error), verified (integrity check passed).", - "x-example": "completed" + "example": "completed" }, "sizeBytes": { "type": "integer", "description": "Backup size in bytes.", - "x-example": 1073741824, - "format": "int32" + "format": "int32", + "example": 1073741824 }, "startedAt": { "type": "string", "description": "Backup start time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "completedAt": { "type": "string", "description": "Backup completion time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "verifiedAt": { "type": "string", "description": "Backup verification time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "expiresAt": { "type": "string", "description": "Backup expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "logPosition": { "type": "string", "description": "Transaction-log position the backup anchors at, in the engine's own notation: PostgreSQL `{walSegment}|{lsn}`, MySQL and MariaDB `{binlogFile}|{offset}`, MongoDB `{seconds}|{increment}`. Empty when the backup recorded no position, which is the case for backup types that carry none.", - "x-example": "000000010000000000000003|0\/3000148", + "example": "000000010000000000000003|0\/3000148", "nullable": true }, "error": { "type": "string", "description": "Error message if backup failed.", - "x-example": "" + "example": "" } }, "required": [ @@ -92045,8 +92005,8 @@ "total": { "type": "integer", "description": "Total number of backups.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "backups": { "type": "array", @@ -92054,7 +92014,7 @@ "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseBackup" }, - "x-example": [] + "example": [] } }, "required": [ @@ -92073,27 +92033,27 @@ "provider": { "type": "string", "description": "Storage provider. Possible values: s3 (Amazon S3 or S3-compatible), gcs (Google Cloud Storage), azure (Azure Blob Storage).", - "x-example": "s3" + "example": "s3" }, "bucket": { "type": "string", "description": "Storage bucket or container name.", - "x-example": "my-backup-bucket" + "example": "my-backup-bucket" }, "region": { "type": "string", "description": "Storage region.", - "x-example": "us-east-1" + "example": "us-east-1" }, "prefix": { "type": "string", "description": "Object key prefix for backups.", - "x-example": "backups\/" + "example": "backups\/" }, "endpoint": { "type": "string", "description": "Custom endpoint for S3-compatible storage.", - "x-example": "https:\/\/minio.example.com" + "example": "https:\/\/minio.example.com" } }, "required": [ @@ -92118,57 +92078,57 @@ "bandwidth": { "type": "integer", "description": "Bandwidth limit", - "x-example": 5, "format": "int32", + "example": 5, "nullable": true }, "storage": { "type": "integer", "description": "Storage limit", - "x-example": 150, "format": "int32", + "example": 150, "nullable": true }, "users": { "type": "integer", "description": "Users limit", - "x-example": 200000, "format": "int32", + "example": 200000, "nullable": true }, "executions": { "type": "integer", "description": "Executions limit", - "x-example": 750000, "format": "int32", + "example": 750000, "nullable": true }, "GBHours": { "type": "integer", "description": "GBHours limit", - "x-example": 100, "format": "int32", + "example": 100, "nullable": true }, "imageTransformations": { "type": "integer", "description": "Image transformations limit", - "x-example": 100, "format": "int32", + "example": 100, "nullable": true }, "authPhone": { "type": "integer", "description": "Auth phone limit", - "x-example": 10, "format": "int32", + "example": 10, "nullable": true }, "budgetLimit": { "type": "integer", "description": "Budget limit percentage", - "x-example": 100, "format": "int32", + "example": 100, "nullable": true } }, @@ -92190,217 +92150,217 @@ "$id": { "type": "string", "description": "Plan ID.", - "x-example": "tier-0" + "example": "tier-0" }, "name": { "type": "string", "description": "Plan name", - "x-example": "Hobby" + "example": "Hobby" }, "desc": { "type": "string", "description": "Plan description", - "x-example": "Hobby plan" + "example": "Hobby plan" }, "order": { "type": "integer", "description": "Plan order", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "price": { "type": "number", "description": "Price", - "x-example": 25, - "format": "double" + "format": "double", + "example": 25 }, "trial": { "type": "integer", "description": "Trial days", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "bandwidth": { "type": "integer", "description": "Bandwidth", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "storage": { "type": "integer", "description": "Storage", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "imageTransformations": { "type": "integer", "description": "Image Transformations", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "screenshotsGenerated": { "type": "integer", "description": "Screenshots generated", - "x-example": 50, - "format": "int32" + "format": "int32", + "example": 50 }, "members": { "type": "integer", "description": "Members", - "x-example": 25, "format": "int32", + "example": 25, "nullable": true }, "webhooks": { "type": "integer", "description": "Webhooks", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "wafRules": { "type": "integer", "description": "Maximum WAF rules per project", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "projects": { "type": "integer", "description": "Projects", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "platforms": { "type": "integer", "description": "Platforms", - "x-example": 3, - "format": "int32" + "format": "int32", + "example": 3 }, "users": { "type": "integer", "description": "Users", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "teams": { "type": "integer", "description": "Teams", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "databases": { "type": "integer", "description": "Databases", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "databasesReads": { "type": "integer", "description": "Database reads per month", - "x-example": 500000, - "format": "int32" + "format": "int32", + "example": 500000 }, "databasesWrites": { "type": "integer", "description": "Database writes per month", - "x-example": 250000, - "format": "int32" + "format": "int32", + "example": 250000 }, "databasesBatchSize": { "type": "integer", "description": "Database batch size limit", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "buckets": { "type": "integer", "description": "Buckets", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "fileSize": { "type": "integer", "description": "File size", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "functions": { "type": "integer", "description": "Functions", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "sites": { "type": "integer", "description": "Sites", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "executions": { "type": "integer", "description": "Function executions", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "executionsRetentionCount": { "type": "integer", "description": "Rolling max executions retained per function\/site", - "x-example": 10000, - "format": "int32" + "format": "int32", + "example": 10000 }, "GBHours": { "type": "integer", "description": "GB hours for functions", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "realtime": { "type": "integer", "description": "Realtime connections", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "realtimeMessages": { "type": "integer", "description": "Realtime messages", - "x-example": 100000, - "format": "int32" + "format": "int32", + "example": 100000 }, "messages": { "type": "integer", "description": "Messages per month", - "x-example": 1000, - "format": "int32" + "format": "int32", + "example": 1000 }, "topics": { "type": "integer", "description": "Topics for messaging", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "authPhone": { "type": "integer", "description": "SMS authentications per month", - "x-example": 10, - "format": "int32" + "format": "int32", + "example": 10 }, "domains": { "type": "integer", "description": "Custom domains", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "activityLogs": { "type": "integer", "description": "Activity log days", - "x-example": 7, "format": "int32", + "example": 7, "nullable": true }, "usageLogs": { "type": "integer", "description": "Usage history days", - "x-example": 30, - "format": "int32" + "format": "int32", + "example": 30 }, "usageLogsIntervals": { "type": "array", @@ -92408,7 +92368,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "15m", "1h", "1d" @@ -92418,19 +92378,18 @@ "projectInactivityDays": { "type": "integer", "description": "Number of days of console inactivity before a project is paused. 0 means pausing is disabled.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "alertLimit": { "type": "integer", "description": "Alert threshold percentage", - "x-example": 80, - "format": "int32" + "format": "int32", + "example": 80 }, "usage": { "type": "object", "description": "Additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/usageBillingPlan" @@ -92440,7 +92399,6 @@ "addons": { "type": "object", "description": "Addons", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanAddon" @@ -92450,108 +92408,107 @@ "budgetCapEnabled": { "type": "boolean", "description": "Budget cap enabled or disabled.", - "x-example": true + "example": true }, "customSmtp": { "type": "boolean", "description": "Custom SMTP", - "x-example": true + "example": true }, "emailBranding": { "type": "boolean", "description": "Appwrite branding in email", - "x-example": true + "example": true }, "requiresPaymentMethod": { "type": "boolean", "description": "Does plan require payment method", - "x-example": true + "example": true }, "requiresBillingAddress": { "type": "boolean", "description": "Does plan require billing address", - "x-example": true + "example": true }, "isAvailable": { "type": "boolean", "description": "Is the billing plan available", - "x-example": true + "example": true }, "selfService": { "type": "boolean", "description": "Can user change the plan themselves", - "x-example": true + "example": true }, "premiumSupport": { "type": "boolean", "description": "Does plan enable premium support", - "x-example": true + "example": true }, "budgeting": { "type": "boolean", "description": "Does plan support budget cap", - "x-example": true + "example": true }, "supportsMockNumbers": { "type": "boolean", "description": "Does plan support mock numbers", - "x-example": true + "example": true }, "supportsOrganizationRoles": { "type": "boolean", "description": "Does plan support organization roles", - "x-example": true + "example": true }, "supportsCredits": { "type": "boolean", "description": "Does plan support credit", - "x-example": true + "example": true }, "supportsDedicatedDatabases": { "type": "boolean", "description": "Does plan support dedicated databases.", - "x-example": true + "example": true }, "supportsDisposableEmailValidation": { "type": "boolean", "description": "Does plan support blocking disposable email addresses.", - "x-example": true + "example": true }, "supportsCanonicalEmailValidation": { "type": "boolean", "description": "Does plan support requiring canonical email addresses.", - "x-example": true + "example": true }, "supportsFreeEmailValidation": { "type": "boolean", "description": "Does plan support blocking free email addresses.", - "x-example": true + "example": true }, "supportsCorporateEmailValidation": { "type": "boolean", "description": "Does plan support restricting sign-ups to corporate email addresses only.", - "x-example": true + "example": true }, "supportsProjectSpecificRoles": { "type": "boolean", "description": "Does plan support project-specific member roles.", - "x-example": true + "example": true }, "backupsEnabled": { "type": "boolean", "description": "Does plan support backup policies.", - "x-example": true, + "example": true, "nullable": true }, "usagePerProject": { "type": "boolean", "description": "Whether usage addons are calculated per project.", - "x-example": true + "example": true }, "supportedAddons": { "type": "object", "description": "Supported addons for this plan", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanSupportedAddons" @@ -92561,31 +92518,30 @@ "backupPolicies": { "type": "integer", "description": "How many policies does plan support", - "x-example": 1, "format": "int32", + "example": 1, "nullable": true }, "deploymentSize": { "type": "integer", "description": "Maximum function and site deployment size in MB", - "x-example": 30, - "format": "int32" + "format": "int32", + "example": 30 }, "buildSize": { "type": "integer", "description": "Maximum function and site deployment size in MB", - "x-example": 2000, - "format": "int32" + "format": "int32", + "example": 2000 }, "databasesAllowEncrypt": { "type": "boolean", "description": "Does the plan support encrypted string attributes or not.", - "x-example": false + "example": false }, "limits": { "type": "object", "description": "Plan specific limits", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanLimits" @@ -92596,7 +92552,7 @@ "group": { "type": "string", "description": "Group of this billing plan for variants", - "x-example": "pro", + "example": "pro", "enum": [ "starter", "pro", @@ -92606,7 +92562,6 @@ "program": { "type": "object", "description": "Details of the program this plan is a part of.", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/program" @@ -92617,13 +92572,12 @@ "databaseComputeCredit": { "type": "number", "description": "Included monthly dedicated-database compute credit in USD. Resets each billing cycle with no roll-over.", - "x-example": 10, - "format": "double" + "format": "double", + "example": 10 }, "dedicatedDatabases": { "type": "object", "description": "Dedicated database limits available to this plan.", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanDedicatedDatabaseLimits" @@ -92782,7 +92736,6 @@ "seats": { "type": "object", "description": "Addon seats", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanAddonDetails" @@ -92793,7 +92746,6 @@ "projects": { "type": "object", "description": "Addon projects", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlanAddonDetails" @@ -92814,47 +92766,47 @@ "supported": { "type": "boolean", "description": "Is the addon supported in the plan?", - "x-example": true + "example": true }, "planIncluded": { "type": "integer", "description": "Addon plan included value", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "limit": { "type": "integer", "description": "Addon limit", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "type": { "type": "string", "description": "Addon type", - "x-example": "numeric" + "example": "numeric" }, "currency": { "type": "string", "description": "Price currency", - "x-example": "USD", + "example": "USD", "nullable": true }, "price": { "type": "number", "description": "Price", - "x-example": 5, - "format": "double" + "format": "double", + "example": 5 }, "value": { "type": "integer", "description": "Resource value", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "invoiceDesc": { "type": "string", "description": "Description on invoice", - "x-example": "" + "example": "" } }, "required": [ @@ -92884,15 +92836,15 @@ "credits": { "type": "integer", "description": "Credits limit per billing cycle", - "x-example": 100, "format": "int32", + "example": 100, "nullable": true }, "dailyCredits": { "type": "integer", "description": "Daily credits limit (if applicable)", - "x-example": 5, "format": "int32", + "example": 5, "nullable": true } }, @@ -92908,113 +92860,113 @@ "minCpu": { "type": "integer", "description": "Minimum CPU allocation in millicores.", - "x-example": 125, "format": "int32", + "example": 125, "nullable": true }, "maxCpu": { "type": "integer", "description": "Maximum CPU allocation in millicores.", - "x-example": 16000, "format": "int32", + "example": 16000, "nullable": true }, "minMemoryMb": { "type": "integer", "description": "Minimum memory allocation in megabytes.", - "x-example": 128, "format": "int32", + "example": 128, "nullable": true }, "maxMemoryMb": { "type": "integer", "description": "Maximum memory allocation in megabytes.", - "x-example": 65536, "format": "int32", + "example": 65536, "nullable": true }, "minStorageGb": { "type": "integer", "description": "Minimum storage allocation in gigabytes.", - "x-example": 1, "format": "int32", + "example": 1, "nullable": true }, "maxStorageGb": { "type": "integer", "description": "Maximum storage allocation in gigabytes.", - "x-example": 16384, "format": "int32", + "example": 16384, "nullable": true }, "maxReplicas": { "type": "integer", "description": "Maximum number of high-availability replicas per dedicated database.", - "x-example": 5, "format": "int32", + "example": 5, "nullable": true }, "maxConnections": { "type": "integer", "description": "Maximum number of client connections.", - "x-example": 10000, "format": "int32", + "example": 10000, "nullable": true }, "maxIpAllowlistSize": { "type": "integer", "description": "Maximum number of entries allowed in the IP allowlist.", - "x-example": 100, "format": "int32", + "example": 100, "nullable": true }, "maxExtensions": { "type": "integer", "description": "Maximum number of database extensions that can be enabled.", - "x-example": 50, "format": "int32", + "example": 50, "nullable": true }, "maxBackupRetentionDays": { "type": "integer", "description": "Maximum number of days a backup can be retained.", - "x-example": 365, "format": "int32", + "example": 365, "nullable": true }, "maxPitrRetentionDays": { "type": "integer", "description": "Maximum number of days of point-in-time recovery data that can be retained.", - "x-example": 35, "format": "int32", + "example": 35, "nullable": true }, "maxSqlApiMaxRows": { "type": "integer", "description": "Maximum number of rows a single SQL API query can return.", - "x-example": 1000000, "format": "int32", + "example": 1000000, "nullable": true }, "maxSqlApiMaxBytes": { "type": "integer", "description": "Maximum response size in bytes for a single SQL API query.", - "x-example": 104857600, "format": "int32", + "example": 104857600, "nullable": true }, "maxSqlApiTimeoutSeconds": { "type": "integer", "description": "Maximum execution time in seconds for a single SQL API query.", - "x-example": 300, "format": "int32", + "example": 300, "nullable": true }, "maxSqlApiAllowedStatements": { "type": "integer", "description": "Maximum number of SQL statement types that can be permitted through the SQL API.", - "x-example": 10, "format": "int32", + "example": 10, "nullable": true }, "allowedSqlStatements": { @@ -93023,7 +92975,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "select", "insert", "update", @@ -93038,7 +92990,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "ssd" ], "nullable": true @@ -93049,7 +93001,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "async", "sync", "quorum" @@ -93098,17 +93050,17 @@ "baa": { "type": "boolean", "description": "Whether the plan supports BAA (Business Associate Agreement) addon", - "x-example": true + "example": true }, "premiumGeoDB": { "type": "boolean", "description": "Whether the plan supports Premium Geo DB addon (project-level)", - "x-example": true + "example": true }, "premiumGeoDBOrg": { "type": "boolean", "description": "Whether the plan supports Premium Geo DB addon (organization-level)", - "x-example": true + "example": true } }, "required": [ @@ -93129,59 +93081,59 @@ "$createdAt": { "type": "string", "description": "Block creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "resourceType": { "type": "string", "description": "Resource type that is blocked", - "x-example": "project" + "example": "project" }, "resourceId": { "type": "string", "description": "Resource identifier that is blocked", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "mode": { "type": "string", "description": "Block mode. full blocks reads and writes; readOnly blocks writes only.", - "x-example": "readOnly" + "example": "readOnly" }, "reason": { "type": "string", "description": "Reason for the block. Can be null if no reason was provided.", - "x-example": "Payment overdue", + "example": "Payment overdue", "nullable": true }, "expiredAt": { "type": "string", "description": "Block expiration date in ISO 8601 format. Can be null if the block does not expire.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "projectName": { "type": "string", "description": "Name of the project this block applies to.", - "x-example": "My Project" + "example": "My Project" }, "region": { "type": "string", "description": "Region of the project this block applies to.", - "x-example": "fra" + "example": "fra" }, "organizationName": { "type": "string", "description": "Name of the organization that owns the project.", - "x-example": "Acme Inc." + "example": "Acme Inc." }, "organizationId": { "type": "string", "description": "ID of the organization that owns the project.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "billingPlan": { "type": "string", "description": "Billing plan of the organization that owns the project.", - "x-example": "pro" + "example": "pro" } }, "required": [ @@ -93216,64 +93168,64 @@ "branchId": { "type": "string", "description": "Branch identifier.", - "x-example": "a1b2c3d4" + "example": "a1b2c3d4" }, "branchName": { "type": "string", "description": "Branch name.", - "x-example": "branch-a1b2c3d4" + "example": "branch-a1b2c3d4" }, "namespace": { "type": "string", "description": "Kubernetes namespace where the branch is deployed.", - "x-example": "db-myproject-mydb-branch-a1b2c3d4" + "example": "db-myproject-mydb-branch-a1b2c3d4" }, "expiresAt": { "type": "integer", "description": "Unix timestamp when the branch expires.", - "x-example": 1711411200, - "format": "int32" + "format": "int32", + "example": 1711411200 }, "host": { "type": "string", "description": "Branch hostname for direct connections.", - "x-example": "db-myproject-mydb-a1b2c3d4.fra.appwrite.center" + "example": "db-myproject-mydb-a1b2c3d4.fra.appwrite.center" }, "port": { "type": "integer", "description": "Branch port. Null until the backing reports one.", - "x-example": 5432, - "format": "int32" + "format": "int32", + "example": 5432 }, "database": { "type": "string", "description": "Database name the client sends for routing to the branch.", - "x-example": "db-myproject-mydb-a1b2c3d4" + "example": "db-myproject-mydb-a1b2c3d4" }, "username": { "type": "string", "description": "Database username. Shared with the parent database.", - "x-example": "appwrite" + "example": "appwrite" }, "password": { "type": "string", "description": "Database password. Shared with the parent database.", - "x-example": "********" + "example": "********" }, "ssl": { "type": "boolean", "description": "Whether SSL is required.", - "x-example": false + "example": false }, "engine": { "type": "string", "description": "Database engine. Possible values: postgresql, mysql, mongodb.", - "x-example": "postgresql" + "example": "postgresql" }, "connectionString": { "type": "string", "description": "Full connection string for the branch.", - "x-example": "postgresql:\/\/appwrite:****@db-myproject-mydb-a1b2c3d4.fra.appwrite.center:5432\/db-myproject-mydb-a1b2c3d4?sslmode=disable" + "example": "postgresql:\/\/appwrite:****@db-myproject-mydb-a1b2c3d4.fra.appwrite.center:5432\/db-myproject-mydb-a1b2c3d4?sslmode=disable" } }, "required": [ @@ -93315,7 +93267,7 @@ "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseBranch" }, - "x-example": [] + "example": [] } }, "required": [ @@ -93332,84 +93284,84 @@ "$id": { "type": "string", "description": "Database migration ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Migration creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Migration update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "projectId": { "type": "string", "description": "Project ID that owns the migrating database.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "databaseId": { "type": "string", "description": "Logical database ID being migrated.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "specification": { "type": "string", "description": "Dedicated compute specification provisioned for the migration target.", - "x-example": "s-2vcpu-4gb" + "example": "s-2vcpu-4gb" }, "phase": { "type": "string", "description": "Migration phase. Possible values: pending, provisioned, capturing, backfilling, catching_up, verifying, ready_to_cutover, cutover, soaking, done, failed, rolled_back.", - "x-example": "pending" + "example": "pending" }, "attempt": { "type": "integer", "description": "Number of times a migration step has failed and been recorded.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "lastError": { "type": "string", "description": "Reason the most recent migration step failed, empty while none has.", - "x-example": "" + "example": "" }, "lagDocuments": { "type": "integer", "description": "Number of documents still pending replication to the target.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "verifiedAt": { "type": "string", "description": "Time the migrated data was verified against the source in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "cutoverAt": { "type": "string", "description": "Time routing was flipped to the target in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "soakUntil": { "type": "string", "description": "Time the post-cutover soak window ends in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "autoCutover": { "type": "boolean", "description": "Whether the migration cuts over automatically once ready. Set when the migration is created and never changed afterwards, so it always reports what was asked for.", - "x-example": true + "example": true }, "cutoverRequested": { "type": "boolean", "description": "Whether a cutover has been requested and not yet attempted. Set by the cutover endpoint and cleared when the attempt is made, so a cutover that fails a check parks the migration again rather than retrying on its own.", - "x-example": false + "example": false }, "paused": { "type": "boolean", "description": "Whether the migration is paused.", - "x-example": false + "example": false } }, "required": [ @@ -93456,173 +93408,173 @@ "$id": { "type": "string", "description": "Dedicated database ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Database creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Database update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "projectId": { "type": "string", "description": "Project ID that owns this database.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Database display name.", - "x-example": "My Production Database" + "example": "My Production Database" }, "api": { "type": "string", "description": "Product API that owns this database: tablesdb, documentsdb, vectorsdb, mysql, postgresql, or mongodb.", - "x-example": "postgresql" + "example": "postgresql" }, "engine": { "type": "string", "description": "Database engine: postgresql, mysql, or mongodb. Null until the backing reports one.", - "x-example": "postgresql" + "example": "postgresql" }, "version": { "type": "string", "description": "Database engine version.", - "x-example": "16" + "example": "16" }, "specification": { "type": "string", "description": "Specification identifier.", - "x-example": "s-2vcpu-2gb" + "example": "s-2vcpu-2gb" }, "backend": { "type": "string", "description": "Database backend provider. Possible values: prisma, edge.", - "x-example": "edge" + "example": "edge" }, "hostname": { "type": "string", "description": "Database hostname for connections.", - "x-example": "db-myproject-mydb.fra.appwrite.center" + "example": "db-myproject-mydb.fra.appwrite.center" }, "connectionPort": { "type": "integer", "description": "Database port for connections. Derived from the engine when the backing has not reported one yet.", - "x-example": 5432, - "format": "int32" + "format": "int32", + "example": 5432 }, "connectionUser": { "type": "string", "description": "Database username for connections.", - "x-example": "appwrite_user" + "example": "appwrite_user" }, "connectionPassword": { "type": "string", "description": "Database password for connections.", - "x-example": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022" + "example": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022" }, "connectionString": { "type": "string", "description": "Full database connection string (URI format).", - "x-example": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.center:5432\/postgres?sslmode=require" + "example": "postgresql:\/\/user:pass@db-myproject-mydb.fra.appwrite.center:5432\/postgres?sslmode=require" }, "ssl": { "type": "boolean", "description": "Whether SSL\/TLS is required for client connections.", - "x-example": true + "example": true }, "status": { "type": "string", "description": "Database status. Possible values: provisioning, ready, inactive, paused, failed, deleted, restoring, scaling.", - "x-example": "ready" + "example": "ready" }, "containerStatus": { "type": "string", "description": "Container status for lifecycle-managed database runtimes: active or inactive.", - "x-example": "active" + "example": "active" }, "lastAccessedAt": { "type": "string", "description": "Last activity timestamp in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "idleUntil": { "type": "string", "description": "Display-only timestamp when the database is expected to be considered idle (ISO 8601 format). Derived from last activity; lifecycle transitions are driven by lifecycleState.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "lifecycleState": { "type": "string", "description": "Idle-lifecycle state of the database. Possible values: active, warm, cold, hibernated.", - "x-example": "active" + "example": "active" }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes of inactivity before container scales to zero.", - "x-example": 15, - "format": "int32" + "format": "int32", + "example": 15 }, "cpu": { "type": "integer", "description": "CPU allocated in millicores.", - "x-example": 2000, - "format": "int32" + "format": "int32", + "example": 2000 }, "memory": { "type": "integer", "description": "Memory allocated in MB.", - "x-example": 4096, - "format": "int32" + "format": "int32", + "example": 4096 }, "storage": { "type": "integer", "description": "Storage allocated in GB.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "storageClass": { "type": "string", "description": "Storage class. Currently always 'ssd'; DigitalOcean exposes a single block-storage class.", - "x-example": "ssd" + "example": "ssd" }, "storageMaxGb": { "type": "integer", "description": "Maximum storage allowed in GB. 0 means use system default.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "nodePool": { "type": "string", "description": "Kubernetes node pool where the database is scheduled.", - "x-example": "db-pool-4vcpu-8gb" + "example": "db-pool-4vcpu-8gb" }, "replicas": { "type": "integer", "description": "Number of high availability replicas. High availability is enabled when greater than 0.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "syncMode": { "type": "string", "description": "Replication sync mode: async, sync, or quorum.", - "x-example": "async" + "example": "async" }, "networkMaxConnections": { "type": "integer", "description": "Maximum concurrent client connections. This is the limit a client pool may reach; the engine's own max_connections reported by the status endpoint is a smaller backend limit the pooler multiplexes onto and does not constrain a client pool.", - "x-example": 500, - "format": "int32" + "format": "int32", + "example": 500 }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds.", - "x-example": 900, - "format": "int32" + "format": "int32", + "example": 900 }, "networkIPAllowlist": { "type": "array", @@ -93630,7 +93582,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "10.0.0.0\/8", "192.168.1.0\/24" ] @@ -93638,56 +93590,56 @@ "backupEnabled": { "type": "boolean", "description": "Whether automatic backups are enabled.", - "x-example": true + "example": true }, "pitr": { "type": "boolean", "description": "Whether point-in-time recovery is enabled.", - "x-example": true + "example": true }, "pitrRetentionDays": { "type": "integer", "description": "Number of days to retain PITR data.", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "storageAutoscaling": { "type": "boolean", "description": "Whether automatic storage expansion is enabled.", - "x-example": true + "example": true }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage that triggers automatic expansion.", - "x-example": 85, - "format": "int32" + "format": "int32", + "example": 85 }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. 0 means no limit.", - "x-example": 500, - "format": "int32" + "format": "int32", + "example": 500 }, "maintenanceWindowDay": { "type": "string", "description": "Day of the week for the maintenance window. Possible values: sun, mon, tue, wed, thu, fri, sat.", - "x-example": "sun" + "example": "sun" }, "maintenanceWindowHourUtc": { "type": "integer", "description": "Hour in UTC (0-23) when the maintenance window starts.", - "x-example": 3, - "format": "int32" + "format": "int32", + "example": 3 }, "metricsEnabled": { "type": "boolean", "description": "Whether metrics collection is enabled.", - "x-example": false + "example": false }, "sqlApiEnabled": { "type": "boolean", "description": "Whether the SQL API sidecar is enabled for this database.", - "x-example": true + "example": true }, "sqlApiAllowedStatements": { "type": "array", @@ -93695,30 +93647,32 @@ "items": { "type": "string" }, - "x-example": "SELECT" + "example": [ + "SELECT" + ] }, "sqlApiMaxRows": { "type": "integer", "description": "Maximum rows returned per SQL API execution. Results larger than this are truncated.", - "x-example": 10000, - "format": "int32" + "format": "int32", + "example": 10000 }, "sqlApiMaxBytes": { "type": "integer", "description": "Maximum serialised SQL API result payload in bytes. Results larger than this are truncated.", - "x-example": 10485760, - "format": "int32" + "format": "int32", + "example": 10485760 }, "sqlApiTimeoutSeconds": { "type": "integer", "description": "Maximum server-side SQL API execution time in seconds before the query is cancelled.", - "x-example": 30, - "format": "int32" + "format": "int32", + "example": 30 }, "error": { "type": "string", "description": "Error message if status is failed.", - "x-example": "" + "example": "" } }, "required": [ @@ -93828,10 +93782,12 @@ "type": "object", "properties": { "rows": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "Result rows as a list of column-name => value maps. Empty for non-returning statements.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "id": 1, "name": "example" @@ -93841,8 +93797,8 @@ "rowCount": { "type": "integer", "description": "Number of rows returned (for SELECT) or affected (for INSERT\/UPDATE\/DELETE).", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "columns": { "type": "array", @@ -93850,24 +93806,24 @@ "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseExecutionColumn" }, - "x-example": [] + "example": [] }, "durationMs": { "type": "integer", "description": "Server-side execution time in milliseconds.", - "x-example": 12, - "format": "int32" + "format": "int32", + "example": 12 }, "truncated": { "type": "boolean", "description": "True when the configured row or byte cap was hit and the result was truncated.", - "x-example": false + "example": false }, "bytes": { "type": "integer", "description": "Serialised payload size in bytes.", - "x-example": 1024, - "format": "int32" + "format": "int32", + "example": 1024 } }, "required": [ @@ -93899,12 +93855,12 @@ "name": { "type": "string", "description": "Column name as returned by the database.", - "x-example": "id" + "example": "id" }, "type": { "type": "string", "description": "Engine-specific column type (e.g. int4, text, timestamptz).", - "x-example": "int4" + "example": "int4" } }, "required": [ @@ -93923,62 +93879,62 @@ "$id": { "type": "string", "description": "Restoration ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Restoration creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "databaseId": { "type": "string", "description": "Database ID being restored into.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "sourceDatabaseId": { "type": "string", "description": "Source database ID when restoring a backup into another database.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "backupId": { "type": "string", "description": "Backup ID used for restoration (null for PITR).", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "type": { "type": "string", "description": "Restoration type. Possible values: backup (restore from a specific backup snapshot), pitr (point-in-time recovery to a specific timestamp).", - "x-example": "backup" + "example": "backup" }, "status": { "type": "string", "description": "Restoration status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error).", - "x-example": "completed" + "example": "completed" }, "targetTime": { "type": "string", "description": "Target time for PITR restoration in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "startedAt": { "type": "string", "description": "Restoration start time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "completedAt": { "type": "string", "description": "Restoration completion time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "error": { "type": "string", "description": "Error message if restoration failed.", - "x-example": "" + "example": "" } }, "required": [ @@ -94017,33 +93973,33 @@ "health": { "type": "string", "description": "Overall health status: healthy, degraded, unhealthy, or unknown when nothing could be measured.", - "x-example": "healthy" + "example": "healthy" }, "ready": { "type": "boolean", "description": "Whether the database is ready to accept connections.", - "x-example": true + "example": true }, "engine": { "type": "string", "description": "Database engine: postgresql, mysql, or mongodb.", - "x-example": "postgresql" + "example": "postgresql" }, "version": { "type": "string", "description": "Database engine version.", - "x-example": "17" + "example": "17" }, "uptime": { "type": "integer", "description": "Database uptime in seconds.", - "x-example": 86400, - "format": "int32" + "format": "int32", + "example": 86400 }, "connections": { "type": "object", "description": "Connection statistics.", - "x-example": { + "example": { "current": 12, "max": 100 }, @@ -94056,35 +94012,35 @@ "syncMode": { "type": "string", "description": "Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.", - "x-example": "async" + "example": "async" }, "effectiveSyncMode": { "type": "string", "description": "Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read.", - "x-example": "async", + "example": "async", "nullable": true }, "syncDegraded": { "type": "boolean", "description": "Whether the enforced replication is weaker than the requested syncMode.", - "x-example": false + "example": false }, "syncAcknowledgements": { "type": "integer", "description": "Number of standby acknowledgements the primary waits for before a write is committed.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "syncStandbyCount": { "type": "integer", "description": "Number of standbys registered with the primary for synchronous replication.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "syncStateConfirmed": { "type": "boolean", "description": "Whether the other sync fields are an engine reading rather than a recorded estimate. True when the primary answered what it is enforcing, including when that answer contradicted the record, in which case the contradicted values are replaced by the ones the engine reports. False when the reading could not be taken: the probe did not answer, there was no engine to ask, or the values describe a configuration change just applied rather than anything measured. Absent when no engine was asked at all, so an unprobed database is distinguishable from an unconfirmed one. False never means a standby was found lagging, because it is the absence of a reading rather than a negative one, so draw no conclusion about replication health from it or from a response that omits it.", - "x-example": true, + "example": true, "nullable": true }, "replicas": { @@ -94093,7 +94049,7 @@ "items": { "$ref": "#\/components\/schemas\/databaseStatusReplica" }, - "x-example": [ + "example": [ { "index": 0, "role": "primary", @@ -94116,14 +94072,16 @@ "items": { "$ref": "#\/components\/schemas\/databaseStatusVolume" }, - "x-example": { - "data": { - "path": "\/var\/lib\/postgresql\/data", - "usedPercent": "45%", - "available": "55GB", - "mounted": true + "example": [ + { + "data": { + "path": "\/var\/lib\/postgresql\/data", + "usedPercent": "45%", + "available": "55GB", + "mounted": true + } } - } + ] } }, "required": [ @@ -94192,7 +94150,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "pgvector", "uuid-ossp" ] @@ -94203,7 +94161,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "postgis", "pg_trgm" ] @@ -94214,7 +94172,7 @@ "items": { "$ref": "#\/components\/schemas\/postgresExtension" }, - "x-example": [] + "example": [] } }, "required": [ @@ -94241,29 +94199,29 @@ "$id": { "type": "string", "description": "Member identifier.", - "x-example": "1" + "example": "1" }, "role": { "type": "string", "description": "Member role. Possible values: primary (accepts reads and writes), replica (read-only follower), unknown (placement not established; reported while a transition is moving or restarting the topology and this member has not been probed, so no member can be named the write target).", - "x-example": "replica" + "example": "replica" }, "status": { "type": "string", "description": "Member pod status. Possible values: pending (configured but absent from the backend topology, so nothing is bringing it up), provisioning (pod missing or Pending), starting (Running but not Ready), active (Running and Ready), failed (Failed phase or CrashLoopBackOff container), or the lowercased pod phase reported by the cluster.", - "x-example": "active" + "example": "active" }, "replicating": { "type": "boolean", "description": "Whether the engine reports this member's replication stream as up. Null when no reading was taken: a primary has no stream to report, and a member that is not active, or whose probe did not answer, has none yet. False is a reading and null is the absence of one, so the two are not interchangeable. Read it beside lagSeconds before expecting a failover that names no target to find a promotable standby: a member streaming at a known lag is one, and a member reporting null is not evidence either way.", - "x-example": true, + "example": true, "nullable": true }, "lagSeconds": { "type": "number", "description": "Replication lag in seconds. Null when the lag is not known: a primary has none to report, and a member the backend has not probed has none yet. Also null against `replicating: true`, for a member that is streaming but whose engine printed no numeric lag.", - "x-example": 0.5, "format": "double", + "example": 0.5, "nullable": true } }, @@ -94287,61 +94245,61 @@ "$id": { "type": "string", "description": "Operation ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Operation creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "databaseId": { "type": "string", "description": "Database ID the operation ran against.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "type": { "type": "string", "description": "Operation type, such as provision, update, restore, pausing, resuming, failover, backup-create or cross-region-enable.", - "x-example": "update" + "example": "update" }, "status": { "type": "string", "description": "Operation status. Possible values: running (in progress), completed (finished successfully), failed (ended in an error).", - "x-example": "completed" + "example": "completed" }, "attempts": { "type": "integer", "description": "Number of times this operation has been attempted.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "requestedAt": { "type": "string", "description": "Time the operation was requested, in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "startedAt": { "type": "string", "description": "Time the operation started, in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "completedAt": { "type": "string", "description": "Time the operation reached a terminal state, in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "errorCode": { "type": "string", "description": "Machine-readable failure code. `Interrupted` marks an attempt that ended before its outcome could be confirmed.", - "x-example": "Interrupted" + "example": "Interrupted" }, "errorMessage": { "type": "string", "description": "Failure message if the operation failed.", - "x-example": "" + "example": "" } }, "required": [ @@ -94375,16 +94333,15 @@ "total": { "type": "integer", "description": "Total number of operations.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "operations": { "type": "array", "description": "List of operations.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseOperation" - }, - "x-example": "" + } } }, "required": [ @@ -94403,41 +94360,41 @@ "replicas": { "type": "integer", "description": "Number of configured replicas. Zero means high availability is disabled.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "syncMode": { "type": "string", "description": "Requested replication sync mode. Possible values: async (asynchronous, fastest), sync (synchronous, strong consistency), quorum (quorum-based, majority of replicas must confirm). This is what was asked for; compare it with effectiveSyncMode for what the primary is enforcing.", - "x-example": "async" + "example": "async" }, "effectiveSyncMode": { "type": "string", "description": "Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read. A value below the requested syncMode means writes are being acknowledged with weaker durability than configured.", - "x-example": "async", + "example": "async", "nullable": true }, "syncDegraded": { "type": "boolean", "description": "Whether the enforced replication is weaker than the requested syncMode.", - "x-example": false + "example": false }, "syncAcknowledgements": { "type": "integer", "description": "Number of standby acknowledgements the primary waits for before a write is committed. Zero means writes are acknowledged locally.", - "x-example": 1, - "format": "int32" + "format": "int32", + "example": 1 }, "syncStandbyCount": { "type": "integer", "description": "Number of standbys registered with the primary for synchronous replication.", - "x-example": 2, - "format": "int32" + "format": "int32", + "example": 2 }, "syncStateConfirmed": { "type": "boolean", "description": "Whether the other sync fields are an engine reading rather than a recorded estimate. True when the primary answered what it is enforcing, including when that answer contradicted the record, in which case the contradicted values are replaced by the ones the engine reports. False when the reading could not be taken: the probe did not answer, there was no engine to ask, or the values describe a configuration change just applied rather than anything measured. Absent when no engine was asked at all, so an unprobed database is distinguishable from an unconfirmed one. False never means a standby was found lagging, because it is the absence of a reading rather than a negative one, so draw no conclusion about replication health from it or from a response that omits it.", - "x-example": true, + "example": true, "nullable": true }, "members": { @@ -94446,7 +94403,7 @@ "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseMember" }, - "x-example": [] + "example": [] } }, "required": [ @@ -94475,22 +94432,22 @@ "domain": { "type": "string", "description": "Domain name.", - "x-example": "appwrite.company.com" + "example": "appwrite.company.com" }, "type": { "type": "string", "description": "Invalidation type. Possible values are \"tag\", \"path\", or \"all\".", - "x-example": "tag" + "example": "tag" }, "reference": { "type": "string", "description": "Invalidated reference. Depending on type this is a cache tag name, a URL path, or empty when type is all.", - "x-example": "products" + "example": "products" }, "status": { "type": "string", "description": "Invalidation status.", - "x-example": "success" + "example": "success" } }, "required": [ @@ -94513,33 +94470,33 @@ "$id": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Team creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Team update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Team name.", - "x-example": "VIP" + "example": "VIP" }, "total": { "type": "integer", "description": "Total number of team members.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "prefs": { "type": "object", "description": "Team preferences as a key-value object", - "x-example": { + "example": { "theme": "pink", "timezone": "UTC" }, @@ -94552,8 +94509,8 @@ "billingBudget": { "type": "integer", "description": "Project budget limit. Null when no budget is set.", - "x-example": 50, "format": "int32", + "example": 50, "nullable": true }, "budgetAlerts": { @@ -94563,7 +94520,7 @@ "type": "integer", "format": "int32" }, - "x-example": [ + "example": [ 50, 75 ] @@ -94571,17 +94528,16 @@ "billingPlan": { "type": "string", "description": "Organization's billing plan ID.", - "x-example": "tier-1" + "example": "tier-1" }, "billingPlanId": { "type": "string", "description": "Organization's billing plan ID.", - "x-example": "tier-1" + "example": "tier-1" }, "billingPlanDetails": { "type": "object", "description": "Organization's billing plan.", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/billingPlan" @@ -94591,107 +94547,106 @@ "billingEmail": { "type": "string", "description": "Billing email set for the organization.", - "x-example": "billing@org.example" + "example": "billing@org.example" }, "billingStartDate": { "type": "string", "description": "Billing cycle start date.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "billingCurrentInvoiceDate": { "type": "string", "description": "Current invoice cycle start date.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "billingNextInvoiceDate": { "type": "string", "description": "Next invoice cycle start date.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "billingTrialStartDate": { "type": "string", "description": "Start date of trial.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true }, "billingTrialDays": { "type": "integer", "description": "Number of trial days.", - "x-example": 14, - "format": "int32" + "format": "int32", + "example": 14 }, "billingAggregationId": { "type": "string", "description": "Current active aggregation id.", - "x-example": "adbc3de4rddfsd" + "example": "adbc3de4rddfsd" }, "billingInvoiceId": { "type": "string", "description": "Current active aggregation id.", - "x-example": "adbc3de4rddfsd" + "example": "adbc3de4rddfsd" }, "paymentMethodId": { "type": "string", "description": "Default payment method.", - "x-example": "adbc3de4rddfsd" + "example": "adbc3de4rddfsd" }, "billingAddressId": { "type": "string", "description": "Default payment method.", - "x-example": "adbc3de4rddfsd", + "example": "adbc3de4rddfsd", "nullable": true }, "backupPaymentMethodId": { "type": "string", "description": "Backup payment method.", - "x-example": "adbc3de4rddfsd", + "example": "adbc3de4rddfsd", "nullable": true }, "status": { "type": "string", "description": "Team status.", - "x-example": "active" + "example": "active" }, "remarks": { "type": "string", "description": "Remarks on team status.", - "x-example": "Pending initial payment", + "example": "Pending initial payment", "nullable": true }, "agreementBAA": { "type": "string", "description": "Organization agreements", - "x-example": "", + "example": "", "nullable": true }, "programManagerName": { "type": "string", "description": "Program manager's name.", - "x-example": "", + "example": "", "nullable": true }, "programManagerCalendar": { "type": "string", "description": "Program manager's calendar link.", - "x-example": "", + "example": "", "nullable": true }, "programDiscordChannelName": { "type": "string", "description": "Program's discord channel name.", - "x-example": "", + "example": "", "nullable": true }, "programDiscordChannelUrl": { "type": "string", "description": "Program's discord channel URL.", - "x-example": "", + "example": "", "nullable": true }, "billingLimits": { "type": "object", "description": "Billing limits reached", - "x-example": "", "allOf": [ { "$ref": "#\/components\/schemas\/billingLimits" @@ -94702,32 +94657,30 @@ "billingPlanDowngrade": { "type": "string", "description": "Billing plan selected for downgrade.", - "x-example": "tier-1", + "example": "tier-1", "nullable": true }, "billingTaxId": { "type": "string", "description": "Tax Id", - "x-example": "", + "example": "", "nullable": true }, "markedForDeletion": { "type": "boolean", - "description": "Marked for deletion", - "x-example": "" + "description": "Marked for deletion" }, "platform": { "type": "string", "description": "Product with which the organization is associated (appwrite or imagine)", - "x-example": "imagine" + "example": "imagine" }, "projects": { "type": "array", "description": "Selected projects", "items": { "type": "string" - }, - "x-example": "" + } } }, "required": [ @@ -94805,12 +94758,12 @@ "earliest": { "type": "string", "description": "Earliest available recovery point.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "latest": { "type": "string", "description": "Latest available recovery point.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -94829,22 +94782,22 @@ "$id": { "type": "string", "description": "Backup policy ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "name": { "type": "string", "description": "Backup policy name.", - "x-example": "Hourly backups" + "example": "Hourly backups" }, "$createdAt": { "type": "string", "description": "Policy creation date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Policy update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "services": { "type": "array", @@ -94852,7 +94805,9 @@ "items": { "type": "string" }, - "x-example": "['databases', 'storage']" + "example": [ + "['databases', 'storage']" + ] }, "resources": { "type": "array", @@ -94860,40 +94815,42 @@ "items": { "type": "string" }, - "x-example": "['databases', 'collections', 'attributes', 'indexes']" + "example": [ + "['databases', 'collections', 'attributes', 'indexes']" + ] }, "resourceId": { "type": "string", "description": "The resource ID to backup. Set only if this policy should backup a single resource.", - "x-example": "DB1", + "example": "DB1", "nullable": true }, "resourceType": { "type": "string", "description": "The resource type to backup. Set only if this policy should backup a single resource.", - "x-example": "database", + "example": "database", "nullable": true }, "retention": { "type": "integer", "description": "How many days to keep the backup before it will be automatically deleted.", - "x-example": 7, - "format": "int32" + "format": "int32", + "example": 7 }, "schedule": { "type": "string", "description": "Policy backup schedule in CRON format.", - "x-example": "0 * * * *" + "example": "0 * * * *" }, "type": { "type": "string", "description": "Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup).", - "x-example": "full" + "example": "full" }, "enabled": { "type": "boolean", "description": "Is this policy enabled.", - "x-example": true + "example": true } }, "required": [ @@ -94930,12 +94887,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether the deny aliased email policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -94954,12 +94911,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether the deny disposable email policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -94978,12 +94935,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether the deny free email policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -95002,12 +94959,12 @@ "$id": { "type": "string", "description": "Policy ID.", - "x-example": "password-dictionary" + "example": "password-dictionary" }, "enabled": { "type": "boolean", "description": "Whether the deny non-corporate email policy is enabled.", - "x-example": true + "example": true } }, "required": [ @@ -95026,55 +94983,55 @@ "enabled": { "type": "boolean", "description": "Whether connection pooling is enabled.", - "x-example": true + "example": true }, "mode": { "type": "string", "description": "Connection pool mode. Possible values: transaction (releases connections back to pool after each transaction), session (holds connections for the entire client session).", - "x-example": "transaction" + "example": "transaction" }, "maxConnections": { "type": "integer", "description": "Client-connection ceiling the pooler accepts. Enforced on MySQL and MariaDB; on PostgreSQL the pooler has no client cap, so this reports the database's advertised networkMaxConnections and cannot be set here.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 }, "defaultPoolSize": { "type": "integer", "description": "Default pool size per user.", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "port": { "type": "integer", "description": "Pooler listening port.", - "x-example": 6432, - "format": "int32" + "format": "int32", + "example": 6432 }, "readWriteSplitting": { "type": "boolean", "description": "Whether SELECTs are routed to HA replicas while writes and locked reads stay on the primary. Active only when HA is enabled.", - "x-example": true + "example": true }, "poolerCpuRequest": { "type": "string", "description": "Effective CPU request applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (5% of DB CPU, floor 100m) unless overridden.", - "x-example": "100m" + "example": "100m" }, "poolerCpuLimit": { "type": "string", "description": "Effective CPU limit applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (10% of DB CPU, floor 200m) unless overridden.", - "x-example": "200m" + "example": "200m" }, "poolerMemoryRequest": { "type": "string", "description": "Effective memory request applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (7.5% of DB memory, floor 64Mi) unless overridden.", - "x-example": "64Mi" + "example": "64Mi" }, "poolerMemoryLimit": { "type": "string", "description": "Effective memory limit applied to the pooler sidecar container (Kubernetes quantity). Returns the proportional default (15% of DB memory, floor 128Mi) unless overridden.", - "x-example": "128Mi" + "example": "128Mi" } }, "required": [ @@ -95109,22 +95066,22 @@ "key": { "type": "string", "description": "Extension key used with CREATE EXTENSION.", - "x-example": "vector" + "example": "vector" }, "name": { "type": "string", "description": "Human-readable extension name.", - "x-example": "pgvector" + "example": "pgvector" }, "description": { "type": "string", "description": "Short description of what the extension provides.", - "x-example": "Vector data type and similarity search for embeddings." + "example": "Vector data type and similarity search for embeddings." }, "category": { "type": "string", "description": "Category the extension belongs to.", - "x-example": "search" + "example": "search" } }, "required": [ @@ -95147,47 +95104,45 @@ "$id": { "type": "string", "description": "Program ID", - "x-example": "" + "example": "" }, "title": { "type": "string", "description": "Program title", - "x-example": "" + "example": "" }, "description": { "type": "string", "description": "Program description", - "x-example": "" + "example": "" }, "tag": { "type": "string", - "description": "Program tag for highlighting on console", - "x-example": null + "description": "Program tag for highlighting on console" }, "icon": { "type": "string", - "description": "Program icon for highlighting on console", - "x-example": null + "description": "Program icon for highlighting on console" }, "url": { "type": "string", "description": "URL for more information on this program", - "x-example": "" + "example": "" }, "active": { "type": "boolean", "description": "Whether this program is active", - "x-example": false + "example": false }, "external": { "type": "boolean", "description": "Whether this program is external", - "x-example": false + "example": false }, "billingPlanId": { "type": "string", "description": "Billing plan ID that this is program is associated with.", - "x-example": "" + "example": "" } }, "required": [ @@ -95220,42 +95175,42 @@ "$id": { "type": "string", "description": "Restoration ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Restoration creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Restoration update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "archiveId": { "type": "string", "description": "Backup archive ID.", - "x-example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7" }, "policyId": { "type": "string", "description": "Backup policy ID.", - "x-example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7" }, "status": { "type": "string", "description": "The status of the restoration. Possible values: pending, downloading, processing, completed, failed.", - "x-example": "completed" + "example": "completed" }, "startedAt": { "type": "string", "description": "The backup start time.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "migrationId": { "type": "string", "description": "Migration ID.", - "x-example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7" }, "services": { "type": "array", @@ -95263,7 +95218,9 @@ "items": { "type": "string" }, - "x-example": "['databases', 'storage']" + "example": [ + "['databases', 'storage']" + ] }, "resources": { "type": "array", @@ -95271,12 +95228,14 @@ "items": { "type": "string" }, - "x-example": "['databases', 'collections', 'attributes', 'indexes']" + "example": [ + "['databases', 'collections', 'attributes', 'indexes']" + ] }, "options": { "type": "string", "description": "Optional data in key-value object. ", - "x-example": "{databases.database[{oldId, newId, newName}]}" + "example": "{databases.database[{oldId, newId, newName}]}" } }, "required": [ @@ -95313,16 +95272,15 @@ "total": { "type": "integer", "description": "Total number of restorations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "restorations": { "type": "array", "description": "List of restorations.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseRestoration" - }, - "x-example": "" + } } }, "required": [ @@ -95341,53 +95299,53 @@ "slug": { "type": "string", "description": "Specification slug. Use this value when creating a dedicated database.", - "x-example": "s-2vcpu-2gb" + "example": "s-2vcpu-2gb" }, "name": { "type": "string", "description": "Human readable specification name.", - "x-example": "Standard" + "example": "Standard" }, "price": { "type": "number", "description": "Monthly price of the specification in USD.", - "x-example": 20, - "format": "double" + "format": "double", + "example": 20 }, "cpu": { "type": "integer", "description": "Allocated CPU in millicores.", - "x-example": 2000, - "format": "int32" + "format": "int32", + "example": 2000 }, "memory": { "type": "integer", "description": "Allocated memory in MB.", - "x-example": 2048, - "format": "int32" + "format": "int32", + "example": 2048 }, "maxConnections": { "type": "integer", "description": "Maximum number of concurrent connections.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 }, "includedStorage": { "type": "integer", "description": "Included storage in GB before overage charges apply.", - "x-example": 25, - "format": "int32" + "format": "int32", + "example": 25 }, "includedBandwidth": { "type": "integer", "description": "Included bandwidth in GB before overage charges apply.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 }, "enabled": { "type": "boolean", "description": "Whether the specification is available on the current plan.", - "x-example": true + "example": true } }, "required": [ @@ -95423,18 +95381,17 @@ "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseSpecification" }, - "x-example": [] + "example": [] }, "total": { "type": "integer", "description": "Total number of specifications.", - "x-example": 9, - "format": "int32" + "format": "int32", + "example": 9 }, "pricing": { "type": "object", "description": "Overage and add-on pricing shared across all specifications.", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/dedicatedDatabaseSpecificationPricing" @@ -95460,26 +95417,26 @@ "storageOverageRate": { "type": "number", "description": "Price per GB of storage above the included amount, per month, in USD.", - "x-example": 0.125, - "format": "double" + "format": "double", + "example": 0.125 }, "bandwidthOverageRate": { "type": "number", "description": "Price per GB of bandwidth above the included amount, per month, in USD.", - "x-example": 0.08, - "format": "double" + "format": "double", + "example": 0.08 }, "replicaRate": { "type": "number", "description": "High availability replica price as a fraction of the specification cost.", - "x-example": 1, - "format": "double" + "format": "double", + "example": 1 }, "pitrRate": { "type": "number", "description": "Point-in-time recovery price as a fraction of the specification cost.", - "x-example": 0.2, - "format": "double" + "format": "double", + "example": 0.2 } }, "required": [ @@ -95502,14 +95459,14 @@ "current": { "type": "integer", "description": "Current number of active connections.", - "x-example": 12, - "format": "int32" + "format": "int32", + "example": 12 }, "max": { "type": "integer", "description": "The engine's own max_connections. On a pooled database this is the backend limit the pooler multiplexes onto, not the ceiling a client pool may reach \u2014 that is networkMaxConnections on the database resource.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 } }, "required": [ @@ -95528,30 +95485,30 @@ "index": { "type": "integer", "description": "Member index within the database. Read `role` for which member accepts writes: a failover moves the primary without renumbering the indexes.", - "x-example": 0, - "format": "int32" + "format": "int32", + "example": 0 }, "role": { "type": "string", "description": "Member role. Possible values: primary (accepts reads and writes), replica (read-only follower), unknown (placement not established; reported while a transition is moving or restarting the topology, so no member can be named the write target).", - "x-example": "primary" + "example": "primary" }, "healthy": { "type": "boolean", "description": "Whether the replica is healthy.", - "x-example": true + "example": true }, "replicating": { "type": "boolean", "description": "Whether the engine reports this member's replication stream as up. Null when no reading was taken: a primary has no stream to report, and a member that is not healthy, or whose probe did not answer, has none yet. `healthy` is a reachability probe of the member itself and says nothing about replication, so a healthy member may still not be replicating.", - "x-example": true, + "example": true, "nullable": true }, "lagSeconds": { "type": "number", "description": "Replication lag in seconds (null for primary). Also null against `replicating: true`, for a member that is streaming but whose engine printed no numeric lag.", - "x-example": 0.2, "format": "double", + "example": 0.2, "nullable": true } }, @@ -95575,22 +95532,22 @@ "path": { "type": "string", "description": "Mount path of the volume.", - "x-example": "\/var\/lib\/postgresql\/data" + "example": "\/var\/lib\/postgresql\/data" }, "usedPercent": { "type": "string", "description": "Percentage of storage used.", - "x-example": "45%" + "example": "45%" }, "available": { "type": "string", "description": "Available storage space.", - "x-example": "55GB" + "example": "55GB" }, "mounted": { "type": "boolean", "description": "Whether the volume is mounted.", - "x-example": true + "example": true } }, "required": [ @@ -95613,7 +95570,6 @@ "bandwidth": { "type": "object", "description": "Bandwidth additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95623,7 +95579,6 @@ "executions": { "type": "object", "description": "Executions additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95633,7 +95588,6 @@ "member": { "type": "object", "description": "Member additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95644,7 +95598,6 @@ "realtime": { "type": "object", "description": "Realtime additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95654,7 +95607,6 @@ "realtimeMessages": { "type": "object", "description": "Realtime messages additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95664,7 +95616,6 @@ "realtimeBandwidth": { "type": "object", "description": "Realtime bandwidth additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95675,7 +95626,6 @@ "storage": { "type": "object", "description": "Storage additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95685,7 +95635,6 @@ "users": { "type": "object", "description": "User additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95695,7 +95644,6 @@ "GBHours": { "type": "object", "description": "GBHour additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95705,7 +95653,6 @@ "imageTransformations": { "type": "object", "description": "Image transformation additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95715,7 +95662,6 @@ "credits": { "type": "object", "description": "Credits additional resources", - "x-example": null, "allOf": [ { "$ref": "#\/components\/schemas\/additionalResource" @@ -95755,47 +95701,47 @@ "$id": { "type": "string", "description": "App ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "App creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "App update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Application name.", - "x-example": "My Application" + "example": "My Application" }, "description": { "type": "string", "description": "Application description shown to users during OAuth2 consent.", - "x-example": "Connect your workspace to My Application." + "example": "Connect your workspace to My Application." }, "clientUri": { "type": "string", "description": "Application homepage URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com" + "example": "https:\/\/example.com" }, "logoUri": { "type": "string", "description": "Application logo URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/logo.png" + "example": "https:\/\/example.com\/logo.png" }, "privacyPolicyUrl": { "type": "string", "description": "Application privacy policy URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/privacy" + "example": "https:\/\/example.com\/privacy" }, "termsUrl": { "type": "string", "description": "Application terms of service URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/terms" + "example": "https:\/\/example.com\/terms" }, "contacts": { "type": "array", @@ -95803,14 +95749,14 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "support@example.com" ] }, "tagline": { "type": "string", "description": "Application tagline shown to users during OAuth2 consent.", - "x-example": "Automate your workspace." + "example": "Automate your workspace." }, "tags": { "type": "array", @@ -95818,7 +95764,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "productivity", "automation" ] @@ -95829,7 +95775,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "featured" ] }, @@ -95839,19 +95785,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/example.com\/screenshot.png" ] }, "supportUrl": { "type": "string", "description": "Application support URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/support" + "example": "https:\/\/example.com\/support" }, "dataDeletionUrl": { "type": "string", "description": "Application data deletion URL shown to users during OAuth2 consent.", - "x-example": "https:\/\/example.com\/data-deletion" + "example": "https:\/\/example.com\/data-deletion" }, "redirectUris": { "type": "array", @@ -95859,7 +95805,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/example.com\/callback" ] }, @@ -95869,34 +95815,34 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/example.com\/logged-out" ] }, "enabled": { "type": "boolean", "description": "Whether the app is enabled or not.", - "x-example": true + "example": true }, "type": { "type": "string", "description": "OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.", - "x-example": "confidential" + "example": "confidential" }, "deviceFlow": { "type": "boolean", "description": "Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).", - "x-example": false + "example": false }, "teamId": { "type": "string", "description": "ID of team that owns the application, if owned by team. Otherwise, user ID will be used.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userId": { "type": "string", "description": "ID of user who owns the application, if owned by user. Otherwise, team ID will be used.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "installationScopes": { "type": "array", @@ -95904,14 +95850,14 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "organization:organization.read" ] }, "installationRedirectUrl": { "type": "string", "description": "URL users are redirected to after creating or updating an installation of this application. Empty for no redirect.", - "x-example": "https:\/\/example.com\/setup" + "example": "https:\/\/example.com\/setup" }, "secrets": { "type": "array", @@ -95919,7 +95865,7 @@ "items": { "$ref": "#\/components\/schemas\/appSecret" }, - "x-example": [] + "example": [] } }, "required": [ @@ -96001,47 +95947,47 @@ "$id": { "type": "string", "description": "Secret ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Secret creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Secret update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "Application ID this secret belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "secret": { "type": "string", "description": "Always empty. The application client secret is returned only once, in the response of the createSecret method.", - "x-example": "" + "example": "" }, "hint": { "type": "string", "description": "Last few characters of the client secret, used to help identify it.", - "x-example": "f5c6c7" + "example": "f5c6c7" }, "createdById": { "type": "string", "description": "ID of the user who created the secret.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the secret.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -96074,47 +96020,47 @@ "$id": { "type": "string", "description": "Secret ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Secret creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Secret update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "Application ID this secret belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "secret": { "type": "string", "description": "Application client secret. Returned only when the secret is created; subsequent reads always return an empty value.", - "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, "hint": { "type": "string", "description": "Last few characters of the client secret, used to help identify it.", - "x-example": "f5c6c7" + "example": "f5c6c7" }, "createdById": { "type": "string", "description": "ID of the user who created the secret.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the secret.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time the secret was last used for authentication in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -96147,27 +96093,27 @@ "value": { "type": "string", "description": "Scope value as requested by apps.", - "x-example": "organization:organization.read" + "example": "organization:organization.read" }, "description": { "type": "string", "description": "Human-readable description of what the scope grants.", - "x-example": "Access to read the organization" + "example": "Access to read the organization" }, "type": { "type": "string", "description": "What the scope grants access to. One of `account`, `project`, or `organization`. Only `project` and `organization` scopes are installable.", - "x-example": "organization" + "example": "organization" }, "category": { "type": "string", "description": "Scope category, used to group scopes on consent and installation screens.", - "x-example": "Organization" + "example": "Organization" }, "deprecated": { "type": "boolean", "description": "Whether the scope is deprecated. Deprecated scopes can still be requested but should not be offered for new grants.", - "x-example": false + "example": false } }, "required": [ @@ -96192,27 +96138,27 @@ "$id": { "type": "string", "description": "Installation ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Installation creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Installation update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "ID of the installed application.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "teamId": { "type": "string", "description": "ID of the team the application is installed on.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "scopes": { "type": "array", @@ -96220,15 +96166,17 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "organization:organization.read" ] }, "authorizationDetails": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "Authorization details granted to the application. Rich authorization request (RFC 9396) style entries; the Appwrite Console stores authorized project IDs here.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "type": "project", "identifiers": [ @@ -96240,17 +96188,17 @@ "createdById": { "type": "string", "description": "ID of the user who created the installation.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the installation.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time an access token was last issued for the installation in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -96294,47 +96242,47 @@ "$id": { "type": "string", "description": "App key ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "App key creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "App key update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "appId": { "type": "string", "description": "Application ID this app key belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "secret": { "type": "string", "description": "App key secret.", - "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, "hint": { "type": "string", "description": "Last few characters of the app key secret, used to help identify it.", - "x-example": "f5c6c7" + "example": "f5c6c7" }, "createdById": { "type": "string", "description": "ID of the user who created the app key.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "createdByName": { "type": "string", "description": "Name of the user who created the app key.", - "x-example": "Walter White" + "example": "Walter White" }, "lastAccessedAt": { "type": "string", "description": "Time the app key was last used for authentication in ISO 8601 format. Null if never used.", - "x-example": "2020-10-15T06:38:00.000+00:00", + "example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -96367,12 +96315,12 @@ "grantId": { "type": "string", "description": "OAuth2 grant ID. Set when the user must give explicit consent; pass it to the approve or reject endpoint. Empty when a redirect URL is returned instead.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "redirectUrl": { "type": "string", "description": "URL the end user should be redirected to when the flow can complete without consent. Empty when consent is still required.", - "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + "example": "https:\/\/example.com\/callback?code=abcde&state=fghij" } }, "required": [ @@ -96391,7 +96339,7 @@ "redirectUrl": { "type": "string", "description": "URL the end user should be redirected to after the grant is approved, carrying the authorization `code` and\/or `id_token` along with the original `state`.", - "x-example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + "example": "https:\/\/example.com\/callback?code=abcde&state=fghij" } }, "required": [ @@ -96408,7 +96356,7 @@ "redirectUrl": { "type": "string", "description": "URL the end user should be redirected to after the grant is rejected, carrying an `access_denied` error.", - "x-example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + "example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" } }, "required": [ @@ -96425,27 +96373,27 @@ "$id": { "type": "string", "description": "Grant ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Grant creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Grant update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "ID of the user the grant belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "appId": { "type": "string", "description": "ID of the OAuth2 client (app) the grant was requested for.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "scopes": { "type": "array", @@ -96453,7 +96401,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "openid", "email", "profile" @@ -96465,35 +96413,35 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/api.example.com\/" ] }, "authorizationDetails": { "type": "string", "description": "Requested authorization_details the user is being asked to consent to, as a JSON string. Each entry has a `type` plus project-defined fields.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, "prompt": { "type": "string", "description": "OIDC prompt directive the consent screen should honor. Space-separated list of: login, consent, select_account.", - "x-example": "login" + "example": "login" }, "redirectUri": { "type": "string", "description": "Redirect URI the user will be sent to after the flow completes.", - "x-example": "https:\/\/example.com\/callback" + "example": "https:\/\/example.com\/callback" }, "authTime": { "type": "integer", "description": "Unix timestamp of when the user last authenticated.", - "x-example": 1592981250, - "format": "int32" + "format": "int32", + "example": 1592981250 }, "expire": { "type": "string", "description": "Grant expiration time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -96538,34 +96486,34 @@ "device_code": { "type": "string", "description": "Device verification code used by the client to poll the token endpoint.", - "x-example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" }, "user_code": { "type": "string", "description": "Short code the end user enters on the verification page.", - "x-example": "ABCD-EFGH" + "example": "ABCD-EFGH" }, "verification_uri": { "type": "string", "description": "URL where the end user enters the user code.", - "x-example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device" + "example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device" }, "verification_uri_complete": { "type": "string", "description": "Verification URL with the user code prefilled as a query parameter.", - "x-example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device?user_code=ABCD-EFGH" + "example": "https:\/\/cloud.appwrite.io\/console\/oauth2\/device?user_code=ABCD-EFGH" }, "expires_in": { "type": "integer", "description": "Lifetime of the device code and user code in seconds.", - "x-example": 900, - "format": "int32" + "format": "int32", + "example": 900 }, "interval": { "type": "integer", "description": "Minimum polling interval for the token endpoint in seconds.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 } }, "required": [ @@ -96592,13 +96540,13 @@ "request_uri": { "type": "string", "description": "Authorization request handle to pass to the authorize endpoint.", - "x-example": "urn:appwrite:oauth2:request:5e5ea5c16897e" + "example": "urn:appwrite:oauth2:request:5e5ea5c16897e" }, "expires_in": { "type": "integer", "description": "Lifetime of the authorization request handle in seconds.", - "x-example": 600, - "format": "int32" + "format": "int32", + "example": 600 } }, "required": [ @@ -96617,39 +96565,39 @@ "access_token": { "type": "string", "description": "OAuth2 access token.", - "x-example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..." + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..." }, "token_type": { "type": "string", "description": "OAuth2 token type.", - "x-example": "Bearer" + "example": "Bearer" }, "expires_in": { "type": "integer", "description": "Access token lifetime in seconds.", - "x-example": 3600, - "format": "int32" + "format": "int32", + "example": 3600 }, "refresh_token": { "type": "string", "description": "OAuth2 refresh token.", - "x-example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." }, "scope": { "type": "string", "description": "Space-separated scopes granted to the access token.", - "x-example": "openid email profile" + "example": "openid email profile" }, "authorization_details": { "type": "string", "description": "Granted RFC 9396 authorization details as a JSON string.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\"]}]", + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\"]}]", "nullable": true }, "id_token": { "type": "string", "description": "OpenID Connect ID token. Returned when the `openid` scope is granted.", - "x-example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", "nullable": true } }, @@ -96677,32 +96625,32 @@ "$id": { "type": "string", "description": "Consent ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Consent creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Consent update date in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "userId": { "type": "string", "description": "ID of the user the consent belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "appId": { "type": "string", "description": "ID of the registered app the consent was given to. Empty for URL-form (CIMD) clients.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "cimdUrl": { "type": "string", "description": "Client ID metadata document URL of the client the consent was given to. Empty for registered apps.", - "x-example": "https:\/\/example.com\/.well-known\/client-metadata.json" + "example": "https:\/\/example.com\/.well-known\/client-metadata.json" }, "scopes": { "type": "array", @@ -96710,7 +96658,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "openid", "email", "profile" @@ -96722,19 +96670,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/api.example.com\/" ] }, "authorizationDetails": { "type": "string", "description": "Authorization details the user consented to, as a JSON string. Each entry has a `type` plus project-defined fields.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, "expire": { "type": "string", "description": "Consent expiration time in ISO 8601 format. Empty when the consent has no token-bound expiry yet.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -96775,37 +96723,37 @@ "$id": { "type": "string", "description": "Token family ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "$createdAt": { "type": "string", "description": "Token creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "Token update date in ISO 8601 format. Refreshing the token family updates this.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "consentId": { "type": "string", "description": "ID of the consent the token family was issued under.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "userId": { "type": "string", "description": "ID of the user the token family belongs to.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "appId": { "type": "string", "description": "ID of the registered app the token family was issued to. Empty for URL-form (CIMD) clients.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "cimdUrl": { "type": "string", "description": "Client ID metadata document URL of the client the token family was issued to. Empty for registered apps.", - "x-example": "https:\/\/example.com\/.well-known\/client-metadata.json" + "example": "https:\/\/example.com\/.well-known\/client-metadata.json" }, "scopes": { "type": "array", @@ -96813,7 +96761,7 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "openid", "email", "profile" @@ -96825,19 +96773,19 @@ "items": { "type": "string" }, - "x-example": [ + "example": [ "https:\/\/api.example.com\/" ] }, "authorizationDetails": { "type": "string", "description": "Authorization details granted on the token family, as a JSON string. Each entry has a `type` plus project-defined fields.", - "x-example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" }, "expire": { "type": "string", "description": "Expiration time of the current access token of this family in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" } }, "required": [ @@ -96880,52 +96828,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -96938,19 +96886,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -96964,7 +96914,7 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} } }, "required": [ @@ -97015,52 +96965,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -97073,19 +97023,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -97099,7 +97051,7 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} } }, "required": [ @@ -97150,52 +97102,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -97208,19 +97160,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -97234,7 +97188,7 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} } }, "required": [ @@ -97285,52 +97239,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -97343,19 +97297,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -97369,24 +97325,24 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} }, "challengeType": { "type": "string", "description": "Challenge type enforced when the rule matches.", - "x-example": "compute" + "example": "compute" }, "difficulty": { "type": "integer", "description": "Challenge difficulty from 1 (easiest) to 5 (hardest) enforced when the rule matches.", - "x-example": 3, - "format": "int32" + "format": "int32", + "example": 3 }, "ttl": { "type": "integer", "description": "Seconds a visitor stays cleared after passing the challenge before being challenged again.", - "x-example": 1800, - "format": "int32" + "format": "int32", + "example": 1800 } }, "required": [ @@ -97443,52 +97399,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -97501,19 +97457,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -97527,35 +97485,35 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} }, "limit": { "type": "integer", "description": "Maximum number of matching requests allowed for the given interval.", - "x-example": 1000, - "format": "int32" + "format": "int32", + "example": 1000 }, "interval": { "type": "integer", "description": "Interval in seconds for the rate limit window.", - "x-example": 60, - "format": "int32" + "format": "int32", + "example": 60 }, "key": { "type": "string", "description": "Rate limit key: `ip` limits per client IP, `userId` limits per authenticated user.", - "x-example": "userId" + "example": "userId" }, "strategy": { "type": "string", "description": "Rate limit strategy: `fixedWindow`, `slidingWindow`, or `tokenBucket`.", - "x-example": "slidingWindow" + "example": "slidingWindow" }, "maxBucketSize": { "type": "integer", "description": "Maximum burst capacity in tokens, applied by the `tokenBucket` strategy. The sustained refill rate is `limit \/ interval`. Defaults to `limit`.", - "x-example": 200, - "format": "int32" + "format": "int32", + "example": 200 } }, "required": [ @@ -97616,52 +97574,52 @@ "$id": { "type": "string", "description": "Rule ID.", - "x-example": "wafRule1" + "example": "wafRule1" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "x-example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00" }, "name": { "type": "string", "description": "Human friendly rule name.", - "x-example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic" }, "description": { "type": "string", "description": "Optional description for the rule.", - "x-example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql" }, "teamId": { "type": "string", "description": "Team ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "projectId": { "type": "string", "description": "Project ID.", - "x-example": "cloudConsole" + "example": "cloudConsole" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "x-example": "functions" + "example": "functions" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "x-example": "functionId" + "example": "functionId" }, "action": { "type": "string", "description": "Action performed when the rule matches.", - "x-example": "deny", + "example": "deny", "enum": [ "bypass", "deny", @@ -97674,19 +97632,21 @@ "priority": { "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", - "x-example": 100, - "format": "int32" + "format": "int32", + "example": 100 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "x-example": true + "example": true }, "conditions": { - "type": "object", - "additionalProperties": true, + "type": "array", "description": "List of conditions evaluated for this rule.", - "x-example": [ + "items": { + "type": "object" + }, + "example": [ { "method": "equal", "attribute": "ip", @@ -97700,18 +97660,18 @@ "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "x-example": [] + "example": {} }, "location": { "type": "string", "description": "Target location for the redirect.", - "x-example": "\/maintenance" + "example": "\/maintenance" }, "statusCode": { "type": "integer", "description": "HTTP status code used for the redirect.", - "x-example": 301, - "format": "int32" + "format": "int32", + "example": 301 } }, "required": [ @@ -97766,16 +97726,15 @@ "total": { "type": "integer", "description": "Total number of rules that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "rules": { "type": "array", "description": "List of rules.", "items": { "$ref": "#\/components\/schemas\/wafRule" - }, - "x-example": "" + } } }, "required": [ @@ -97794,17 +97753,17 @@ "$id": { "type": "string", "description": "Project ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" }, "region": { "type": "string", "description": "Region ID the project is deployed in.", - "x-example": "fra" + "example": "fra" }, "endpoint": { "type": "string", "description": "API endpoint of the region the project is deployed in. Empty when the region has no public hostname configured.", - "x-example": "https:\/\/fra.cloud.appwrite.io\/v1" + "example": "https:\/\/fra.cloud.appwrite.io\/v1" } }, "required": [ @@ -97825,7 +97784,7 @@ "$id": { "type": "string", "description": "Organization ID.", - "x-example": "5e5ea5c16897e" + "example": "5e5ea5c16897e" } }, "required": [ @@ -97842,16 +97801,15 @@ "total": { "type": "integer", "description": "Total number of projects that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "projects": { "type": "array", "description": "List of projects.", "items": { "$ref": "#\/components\/schemas\/oauth2Project" - }, - "x-example": "" + } } }, "required": [ @@ -97870,16 +97828,15 @@ "total": { "type": "integer", "description": "Total number of organizations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "organizations": { "type": "array", "description": "List of organizations.", "items": { "$ref": "#\/components\/schemas\/oauth2Organization" - }, - "x-example": "" + } } }, "required": [ @@ -97898,16 +97855,15 @@ "total": { "type": "integer", "description": "Total number of consents that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "consents": { "type": "array", "description": "List of consents.", "items": { "$ref": "#\/components\/schemas\/oauth2Consent" - }, - "x-example": "" + } } }, "required": [ @@ -97926,16 +97882,15 @@ "total": { "type": "integer", "description": "Total number of tokens that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "tokens": { "type": "array", "description": "List of tokens.", "items": { "$ref": "#\/components\/schemas\/oauth2ConsentToken" - }, - "x-example": "" + } } }, "required": [ @@ -97954,16 +97909,15 @@ "total": { "type": "integer", "description": "Total number of events that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "events": { "type": "array", "description": "List of events.", "items": { "$ref": "#\/components\/schemas\/activityEvent" - }, - "x-example": "" + } } }, "required": [ @@ -97982,16 +97936,15 @@ "total": { "type": "integer", "description": "Total number of archives that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "archives": { "type": "array", "description": "List of archives.", "items": { "$ref": "#\/components\/schemas\/backupArchive" - }, - "x-example": "" + } } }, "required": [ @@ -98010,16 +97963,15 @@ "total": { "type": "integer", "description": "Total number of policies that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "policies": { "type": "array", "description": "List of policies.", "items": { "$ref": "#\/components\/schemas\/backupPolicy" - }, - "x-example": "" + } } }, "required": [ @@ -98038,16 +97990,15 @@ "total": { "type": "integer", "description": "Total number of restorations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "restorations": { "type": "array", "description": "List of restorations.", "items": { "$ref": "#\/components\/schemas\/backupRestoration" - }, - "x-example": "" + } } }, "required": [ @@ -98066,16 +98017,15 @@ "total": { "type": "integer", "description": "Total number of migrations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "migrations": { "type": "array", "description": "List of migrations.", "items": { "$ref": "#\/components\/schemas\/databaseMigration" - }, - "x-example": "" + } } }, "required": [ @@ -98094,16 +98044,15 @@ "total": { "type": "integer", "description": "Total number of databases that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "databases": { "type": "array", "description": "List of databases.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabase" - }, - "x-example": "" + } } }, "required": [ @@ -98122,16 +98071,15 @@ "total": { "type": "integer", "description": "Total number of apps that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "apps": { "type": "array", "description": "List of apps.", "items": { "$ref": "#\/components\/schemas\/app" - }, - "x-example": "" + } } }, "required": [ @@ -98150,16 +98098,15 @@ "total": { "type": "integer", "description": "Total number of secrets that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "secrets": { "type": "array", "description": "List of secrets.", "items": { "$ref": "#\/components\/schemas\/appSecret" - }, - "x-example": "" + } } }, "required": [ @@ -98178,16 +98125,15 @@ "total": { "type": "integer", "description": "Total number of scopes that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "scopes": { "type": "array", "description": "List of scopes.", "items": { "$ref": "#\/components\/schemas\/appScope" - }, - "x-example": "" + } } }, "required": [ @@ -98206,16 +98152,15 @@ "total": { "type": "integer", "description": "Total number of installations that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "installations": { "type": "array", "description": "List of installations.", "items": { "$ref": "#\/components\/schemas\/appInstallation" - }, - "x-example": "" + } } }, "required": [ @@ -98234,16 +98179,15 @@ "total": { "type": "integer", "description": "Total number of keys that matched your query.", - "x-example": 5, - "format": "int32" + "format": "int32", + "example": 5 }, "keys": { "type": "array", "description": "List of keys.", "items": { "$ref": "#\/components\/schemas\/appKey" - }, - "x-example": "" + } } }, "required": [ From 6124ab004f417a4279fdc9943c11b0b7ae5f9e73 Mon Sep 17 00:00:00 2001 From: Chirag Aggarwal <chiragaggarwal5k@gmail.com> Date: Wed, 19 Aug 2026 15:09:49 +0530 Subject: [PATCH 2/2] fix: preserve empty array examples --- specs/1.9.x/open-api3-1.9.x-client.json | 78 ++++-- specs/1.9.x/open-api3-1.9.x-console.json | 325 +++++++++++++++-------- specs/1.9.x/open-api3-1.9.x-server.json | 216 ++++++++++----- 3 files changed, 413 insertions(+), 206 deletions(-) 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 e69ca8790..f5fdc060e 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 @@ -20138,7 +20138,8 @@ "description": "List of rows.", "items": { "$ref": "#\/components\/schemas\/row" - } + }, + "example": [] } }, "required": [ @@ -20165,7 +20166,8 @@ "description": "List of documents.", "items": { "$ref": "#\/components\/schemas\/document" - } + }, + "example": [] } }, "required": [ @@ -20192,7 +20194,8 @@ "description": "List of presences.", "items": { "$ref": "#\/components\/schemas\/presence" - } + }, + "example": [] } }, "required": [ @@ -20219,7 +20222,8 @@ "description": "List of sessions.", "items": { "$ref": "#\/components\/schemas\/session" - } + }, + "example": [] } }, "required": [ @@ -20246,7 +20250,8 @@ "description": "List of identities.", "items": { "$ref": "#\/components\/schemas\/identity" - } + }, + "example": [] } }, "required": [ @@ -20273,7 +20278,8 @@ "description": "List of logs.", "items": { "$ref": "#\/components\/schemas\/log" - } + }, + "example": [] } }, "required": [ @@ -20300,7 +20306,8 @@ "description": "List of files.", "items": { "$ref": "#\/components\/schemas\/file" - } + }, + "example": [] } }, "required": [ @@ -20327,7 +20334,8 @@ "description": "List of teams.", "items": { "$ref": "#\/components\/schemas\/team" - } + }, + "example": [] } }, "required": [ @@ -20354,7 +20362,8 @@ "description": "List of memberships.", "items": { "$ref": "#\/components\/schemas\/membership" - } + }, + "example": [] } }, "required": [ @@ -20381,7 +20390,8 @@ "description": "List of executions.", "items": { "$ref": "#\/components\/schemas\/execution" - } + }, + "example": [] } }, "required": [ @@ -20408,7 +20418,8 @@ "description": "List of countries.", "items": { "$ref": "#\/components\/schemas\/country" - } + }, + "example": [] } }, "required": [ @@ -20435,7 +20446,8 @@ "description": "List of continents.", "items": { "$ref": "#\/components\/schemas\/continent" - } + }, + "example": [] } }, "required": [ @@ -20462,7 +20474,8 @@ "description": "List of languages.", "items": { "$ref": "#\/components\/schemas\/language" - } + }, + "example": [] } }, "required": [ @@ -20489,7 +20502,8 @@ "description": "List of currencies.", "items": { "$ref": "#\/components\/schemas\/currency" - } + }, + "example": [] } }, "required": [ @@ -20516,7 +20530,8 @@ "description": "List of phones.", "items": { "$ref": "#\/components\/schemas\/phone" - } + }, + "example": [] } }, "required": [ @@ -20543,7 +20558,8 @@ "description": "List of localeCodes.", "items": { "$ref": "#\/components\/schemas\/localeCode" - } + }, + "example": [] } }, "required": [ @@ -20570,7 +20586,8 @@ "description": "List of transactions.", "items": { "$ref": "#\/components\/schemas\/transaction" - } + }, + "example": [] } }, "required": [ @@ -24213,7 +24230,8 @@ "description": "List of projects.", "items": { "$ref": "#\/components\/schemas\/oauth2Project" - } + }, + "example": [] } }, "required": [ @@ -24240,7 +24258,8 @@ "description": "List of organizations.", "items": { "$ref": "#\/components\/schemas\/oauth2Organization" - } + }, + "example": [] } }, "required": [ @@ -24267,7 +24286,8 @@ "description": "List of consents.", "items": { "$ref": "#\/components\/schemas\/oauth2Consent" - } + }, + "example": [] } }, "required": [ @@ -24294,7 +24314,8 @@ "description": "List of tokens.", "items": { "$ref": "#\/components\/schemas\/oauth2ConsentToken" - } + }, + "example": [] } }, "required": [ @@ -24321,7 +24342,8 @@ "description": "List of apps.", "items": { "$ref": "#\/components\/schemas\/app" - } + }, + "example": [] } }, "required": [ @@ -24348,7 +24370,8 @@ "description": "List of secrets.", "items": { "$ref": "#\/components\/schemas\/appSecret" - } + }, + "example": [] } }, "required": [ @@ -24375,7 +24398,8 @@ "description": "List of scopes.", "items": { "$ref": "#\/components\/schemas\/appScope" - } + }, + "example": [] } }, "required": [ @@ -24402,7 +24426,8 @@ "description": "List of installations.", "items": { "$ref": "#\/components\/schemas\/appInstallation" - } + }, + "example": [] } }, "required": [ @@ -24429,7 +24454,8 @@ "description": "List of keys.", "items": { "$ref": "#\/components\/schemas\/appKey" - } + }, + "example": [] } }, "required": [ 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 8ba2ca910..29cab3b31 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 @@ -94806,7 +94806,8 @@ "description": "List of rows.", "items": { "$ref": "#\/components\/schemas\/row" - } + }, + "example": [] } }, "required": [ @@ -94833,7 +94834,8 @@ "description": "List of documents.", "items": { "$ref": "#\/components\/schemas\/document" - } + }, + "example": [] } }, "required": [ @@ -94860,7 +94862,8 @@ "description": "List of presences.", "items": { "$ref": "#\/components\/schemas\/presence" - } + }, + "example": [] } }, "required": [ @@ -94887,7 +94890,8 @@ "description": "List of tables.", "items": { "$ref": "#\/components\/schemas\/table" - } + }, + "example": [] } }, "required": [ @@ -94914,7 +94918,8 @@ "description": "List of collections.", "items": { "$ref": "#\/components\/schemas\/collection" - } + }, + "example": [] } }, "required": [ @@ -94941,7 +94946,8 @@ "description": "List of databases.", "items": { "$ref": "#\/components\/schemas\/database" - } + }, + "example": [] } }, "required": [ @@ -94968,7 +94974,8 @@ "description": "List of indexes.", "items": { "$ref": "#\/components\/schemas\/index" - } + }, + "example": [] } }, "required": [ @@ -94995,7 +95002,8 @@ "description": "List of indexes.", "items": { "$ref": "#\/components\/schemas\/columnIndex" - } + }, + "example": [] } }, "required": [ @@ -95022,7 +95030,8 @@ "description": "List of users.", "items": { "$ref": "#\/components\/schemas\/user" - } + }, + "example": [] } }, "required": [ @@ -95049,7 +95058,8 @@ "description": "List of sessions.", "items": { "$ref": "#\/components\/schemas\/session" - } + }, + "example": [] } }, "required": [ @@ -95076,7 +95086,8 @@ "description": "List of identities.", "items": { "$ref": "#\/components\/schemas\/identity" - } + }, + "example": [] } }, "required": [ @@ -95103,7 +95114,8 @@ "description": "List of notifications.", "items": { "$ref": "#\/components\/schemas\/notification" - } + }, + "example": [] } }, "required": [ @@ -95130,7 +95142,8 @@ "description": "List of logs.", "items": { "$ref": "#\/components\/schemas\/log" - } + }, + "example": [] } }, "required": [ @@ -95157,7 +95170,8 @@ "description": "List of files.", "items": { "$ref": "#\/components\/schemas\/file" - } + }, + "example": [] } }, "required": [ @@ -95184,7 +95198,8 @@ "description": "List of buckets.", "items": { "$ref": "#\/components\/schemas\/bucket" - } + }, + "example": [] } }, "required": [ @@ -95211,7 +95226,8 @@ "description": "List of tokens.", "items": { "$ref": "#\/components\/schemas\/resourceToken" - } + }, + "example": [] } }, "required": [ @@ -95238,7 +95254,8 @@ "description": "List of teams.", "items": { "$ref": "#\/components\/schemas\/team" - } + }, + "example": [] } }, "required": [ @@ -95265,7 +95282,8 @@ "description": "List of memberships.", "items": { "$ref": "#\/components\/schemas\/membership" - } + }, + "example": [] } }, "required": [ @@ -95292,7 +95310,8 @@ "description": "List of sites.", "items": { "$ref": "#\/components\/schemas\/site" - } + }, + "example": [] } }, "required": [ @@ -95319,7 +95338,8 @@ "description": "List of templates.", "items": { "$ref": "#\/components\/schemas\/templateSite" - } + }, + "example": [] } }, "required": [ @@ -95346,7 +95366,8 @@ "description": "List of functions.", "items": { "$ref": "#\/components\/schemas\/function" - } + }, + "example": [] } }, "required": [ @@ -95373,7 +95394,8 @@ "description": "List of templates.", "items": { "$ref": "#\/components\/schemas\/templateFunction" - } + }, + "example": [] } }, "required": [ @@ -95400,7 +95422,8 @@ "description": "List of installations.", "items": { "$ref": "#\/components\/schemas\/installation" - } + }, + "example": [] } }, "required": [ @@ -95427,7 +95450,8 @@ "description": "List of frameworkProviderRepositories.", "items": { "$ref": "#\/components\/schemas\/providerRepositoryFramework" - } + }, + "example": [] }, "type": { "type": "string", @@ -95461,7 +95485,8 @@ "description": "List of runtimeProviderRepositories.", "items": { "$ref": "#\/components\/schemas\/providerRepositoryRuntime" - } + }, + "example": [] }, "type": { "type": "string", @@ -95540,7 +95565,8 @@ "description": "List of namespaces.", "items": { "$ref": "#\/components\/schemas\/vcsNamespace" - } + }, + "example": [] } }, "required": [ @@ -95567,7 +95593,8 @@ "description": "List of branches.", "items": { "$ref": "#\/components\/schemas\/branch" - } + }, + "example": [] } }, "required": [ @@ -95594,7 +95621,8 @@ "description": "List of frameworks.", "items": { "$ref": "#\/components\/schemas\/framework" - } + }, + "example": [] } }, "required": [ @@ -95621,7 +95649,8 @@ "description": "List of runtimes.", "items": { "$ref": "#\/components\/schemas\/runtime" - } + }, + "example": [] } }, "required": [ @@ -95648,7 +95677,8 @@ "description": "List of deployments.", "items": { "$ref": "#\/components\/schemas\/deployment" - } + }, + "example": [] } }, "required": [ @@ -95675,7 +95705,8 @@ "description": "List of executions.", "items": { "$ref": "#\/components\/schemas\/execution" - } + }, + "example": [] } }, "required": [ @@ -95702,7 +95733,8 @@ "description": "List of projects.", "items": { "$ref": "#\/components\/schemas\/project" - } + }, + "example": [] } }, "required": [ @@ -95729,7 +95761,8 @@ "description": "List of webhooks.", "items": { "$ref": "#\/components\/schemas\/webhook" - } + }, + "example": [] } }, "required": [ @@ -95756,7 +95789,8 @@ "description": "List of keys.", "items": { "$ref": "#\/components\/schemas\/key" - } + }, + "example": [] } }, "required": [ @@ -95783,7 +95817,8 @@ "description": "List of devKeys.", "items": { "$ref": "#\/components\/schemas\/devKey" - } + }, + "example": [] } }, "required": [ @@ -95810,7 +95845,8 @@ "description": "List of countries.", "items": { "$ref": "#\/components\/schemas\/country" - } + }, + "example": [] } }, "required": [ @@ -95837,7 +95873,8 @@ "description": "List of continents.", "items": { "$ref": "#\/components\/schemas\/continent" - } + }, + "example": [] } }, "required": [ @@ -95864,7 +95901,8 @@ "description": "List of languages.", "items": { "$ref": "#\/components\/schemas\/language" - } + }, + "example": [] } }, "required": [ @@ -95891,7 +95929,8 @@ "description": "List of currencies.", "items": { "$ref": "#\/components\/schemas\/currency" - } + }, + "example": [] } }, "required": [ @@ -95918,7 +95957,8 @@ "description": "List of phones.", "items": { "$ref": "#\/components\/schemas\/phone" - } + }, + "example": [] } }, "required": [ @@ -95945,7 +95985,8 @@ "description": "List of variables.", "items": { "$ref": "#\/components\/schemas\/variable" - } + }, + "example": [] } }, "required": [ @@ -95972,7 +96013,8 @@ "description": "List of mockNumbers.", "items": { "$ref": "#\/components\/schemas\/mockNumber" - } + }, + "example": [] } }, "required": [ @@ -96065,7 +96107,8 @@ "deny-corporate-email": "#\/components\/schemas\/policyDenyCorporateEmail" } } - } + }, + "example": [] } }, "required": [ @@ -96092,7 +96135,8 @@ "description": "List of templates.", "items": { "$ref": "#\/components\/schemas\/emailTemplate" - } + }, + "example": [] } }, "required": [ @@ -96119,7 +96163,8 @@ "description": "List of rules.", "items": { "$ref": "#\/components\/schemas\/proxyRule" - } + }, + "example": [] } }, "required": [ @@ -96146,7 +96191,8 @@ "description": "List of schedules.", "items": { "$ref": "#\/components\/schemas\/schedule" - } + }, + "example": [] } }, "required": [ @@ -96167,7 +96213,8 @@ "description": "List of stages.", "items": { "$ref": "#\/components\/schemas\/stage" - } + }, + "example": [] } }, "required": [ @@ -96192,7 +96239,8 @@ "description": "List of localeCodes.", "items": { "$ref": "#\/components\/schemas\/localeCode" - } + }, + "example": [] } }, "required": [ @@ -96219,7 +96267,8 @@ "description": "List of providers.", "items": { "$ref": "#\/components\/schemas\/provider" - } + }, + "example": [] } }, "required": [ @@ -96246,7 +96295,8 @@ "description": "List of messages.", "items": { "$ref": "#\/components\/schemas\/message" - } + }, + "example": [] } }, "required": [ @@ -96273,7 +96323,8 @@ "description": "List of topics.", "items": { "$ref": "#\/components\/schemas\/topic" - } + }, + "example": [] } }, "required": [ @@ -96300,7 +96351,8 @@ "description": "List of subscribers.", "items": { "$ref": "#\/components\/schemas\/subscriber" - } + }, + "example": [] } }, "required": [ @@ -96327,7 +96379,8 @@ "description": "List of targets.", "items": { "$ref": "#\/components\/schemas\/target" - } + }, + "example": [] } }, "required": [ @@ -96354,7 +96407,8 @@ "description": "List of transactions.", "items": { "$ref": "#\/components\/schemas\/transaction" - } + }, + "example": [] } }, "required": [ @@ -96381,7 +96435,8 @@ "description": "List of migrations.", "items": { "$ref": "#\/components\/schemas\/migration" - } + }, + "example": [] } }, "required": [ @@ -96408,7 +96463,8 @@ "description": "List of specifications.", "items": { "$ref": "#\/components\/schemas\/specification" - } + }, + "example": [] } }, "required": [ @@ -96435,7 +96491,8 @@ "description": "List of contents.", "items": { "$ref": "#\/components\/schemas\/vcsContent" - } + }, + "example": [] } }, "required": [ @@ -96462,7 +96519,8 @@ "description": "List of collections.", "items": { "$ref": "#\/components\/schemas\/vectorsdbCollection" - } + }, + "example": [] } }, "required": [ @@ -96489,7 +96547,8 @@ "description": "List of embeddings.", "items": { "$ref": "#\/components\/schemas\/embedding" - } + }, + "example": [] } }, "required": [ @@ -96516,7 +96575,8 @@ "description": "List of insights.", "items": { "$ref": "#\/components\/schemas\/insight" - } + }, + "example": [] } }, "required": [ @@ -96543,7 +96603,8 @@ "description": "List of reports.", "items": { "$ref": "#\/components\/schemas\/report" - } + }, + "example": [] } }, "required": [ @@ -97138,7 +97199,8 @@ } } } - } + }, + "example": [] } }, "required": [ @@ -99566,7 +99628,8 @@ } } } - } + }, + "example": [] } }, "required": [ @@ -105755,7 +105818,8 @@ "description": "Project blocks information", "items": { "$ref": "#\/components\/schemas\/block" - } + }, + "example": [] }, "consoleAccessedAt": { "type": "string", @@ -108391,7 +108455,8 @@ "microsoft": "#\/components\/schemas\/oAuth2Microsoft" } } - } + }, + "example": [] } }, "required": [ @@ -109098,7 +109163,8 @@ "linux": "#\/components\/schemas\/platformLinux" } } - } + }, + "example": [] } }, "required": [ @@ -110765,7 +110831,8 @@ "description": "List of parameters required to configure this OAuth2 provider.", "items": { "$ref": "#\/components\/schemas\/consoleOAuth2ProviderParameter" - } + }, + "example": [] } }, "required": [ @@ -110792,7 +110859,8 @@ "description": "List of OAuth2 providers, each with the parameters required to configure it.", "items": { "$ref": "#\/components\/schemas\/consoleOAuth2Provider" - } + }, + "example": [] } }, "required": [ @@ -110857,7 +110925,8 @@ "description": "List of key scopes, each with its ID and description.", "items": { "$ref": "#\/components\/schemas\/consoleKeyScope" - } + }, + "example": [] } }, "required": [ @@ -112778,7 +112847,8 @@ "description": "List of links.", "items": { "$ref": "#\/components\/schemas\/affiliateLink" - } + }, + "example": [] } }, "required": [ @@ -112885,7 +112955,8 @@ "description": "List of referrals.", "items": { "$ref": "#\/components\/schemas\/affiliateReferral" - } + }, + "example": [] } }, "required": [ @@ -112993,7 +113064,8 @@ "description": "List of rewards.", "items": { "$ref": "#\/components\/schemas\/affiliateReward" - } + }, + "example": [] } }, "required": [ @@ -113035,7 +113107,8 @@ "description": "", "items": { "$ref": "#\/components\/schemas\/usageResources" - } + }, + "example": [] } }, "required": [ @@ -114966,6 +115039,7 @@ "items": { "$ref": "#\/components\/schemas\/review" }, + "example": [], "nullable": true }, "onlyNewOrgs": { @@ -117078,7 +117152,8 @@ "description": "List of operations.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseOperation" - } + }, + "example": [] } }, "required": [ @@ -117605,7 +117680,8 @@ "description": "Selected projects", "items": { "type": "string" - } + }, + "example": [] } }, "required": [ @@ -118768,7 +118844,8 @@ "description": "List of restorations.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseRestoration" - } + }, + "example": [] } }, "required": [ @@ -119482,7 +119559,8 @@ "description": "One entry per requested metric, each carrying its own points[] time series (sums per bucket \/ dimension over time).", "items": { "$ref": "#\/components\/schemas\/usageMetric" - } + }, + "example": [] } }, "required": [ @@ -119508,7 +119586,8 @@ "description": "One entry per requested metric, each carrying its own points[] time series (latest-snapshot per bucket \/ dimension via argMax over time).", "items": { "$ref": "#\/components\/schemas\/usageMetric" - } + }, + "example": [] } }, "required": [ @@ -119534,7 +119613,8 @@ "description": "Data points for this metric, ordered by time ascending. With `interval`, each entry is one bucket; without, each entry is one row of the dimensional or aggregate breakdown.", "items": { "$ref": "#\/components\/schemas\/usageDataPoint" - } + }, + "example": [] } }, "required": [ @@ -122108,7 +122188,8 @@ "description": "List of rules.", "items": { "$ref": "#\/components\/schemas\/wafRule" - } + }, + "example": [] } }, "required": [ @@ -122183,7 +122264,8 @@ "description": "List of projects.", "items": { "$ref": "#\/components\/schemas\/oauth2Project" - } + }, + "example": [] } }, "required": [ @@ -122210,7 +122292,8 @@ "description": "List of organizations.", "items": { "$ref": "#\/components\/schemas\/oauth2Organization" - } + }, + "example": [] } }, "required": [ @@ -122237,7 +122320,8 @@ "description": "List of consents.", "items": { "$ref": "#\/components\/schemas\/oauth2Consent" - } + }, + "example": [] } }, "required": [ @@ -122264,7 +122348,8 @@ "description": "List of tokens.", "items": { "$ref": "#\/components\/schemas\/oauth2ConsentToken" - } + }, + "example": [] } }, "required": [ @@ -122291,7 +122376,8 @@ "description": "List of events.", "items": { "$ref": "#\/components\/schemas\/activityEvent" - } + }, + "example": [] } }, "required": [ @@ -122318,7 +122404,8 @@ "description": "List of addons.", "items": { "$ref": "#\/components\/schemas\/addon" - } + }, + "example": [] } }, "required": [ @@ -122345,7 +122432,8 @@ "description": "List of aggregations.", "items": { "$ref": "#\/components\/schemas\/aggregationTeam" - } + }, + "example": [] } }, "required": [ @@ -122372,7 +122460,8 @@ "description": "List of archives.", "items": { "$ref": "#\/components\/schemas\/backupArchive" - } + }, + "example": [] } }, "required": [ @@ -122399,7 +122488,8 @@ "description": "List of policies.", "items": { "$ref": "#\/components\/schemas\/backupPolicy" - } + }, + "example": [] } }, "required": [ @@ -122426,7 +122516,8 @@ "description": "List of restorations.", "items": { "$ref": "#\/components\/schemas\/backupRestoration" - } + }, + "example": [] } }, "required": [ @@ -122453,7 +122544,8 @@ "description": "List of billingAddresses.", "items": { "$ref": "#\/components\/schemas\/billingAddress" - } + }, + "example": [] } }, "required": [ @@ -122480,7 +122572,8 @@ "description": "List of invoices.", "items": { "$ref": "#\/components\/schemas\/invoice" - } + }, + "example": [] } }, "required": [ @@ -122507,7 +122600,8 @@ "description": "List of plans.", "items": { "$ref": "#\/components\/schemas\/billingPlan" - } + }, + "example": [] } }, "required": [ @@ -122534,7 +122628,8 @@ "description": "List of blocks.", "items": { "$ref": "#\/components\/schemas\/block" - } + }, + "example": [] } }, "required": [ @@ -122561,7 +122656,8 @@ "description": "List of migrations.", "items": { "$ref": "#\/components\/schemas\/databaseMigration" - } + }, + "example": [] } }, "required": [ @@ -122588,7 +122684,8 @@ "description": "List of databases.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabase" - } + }, + "example": [] } }, "required": [ @@ -122615,7 +122712,8 @@ "description": "List of dnsRecords.", "items": { "$ref": "#\/components\/schemas\/dnsRecord" - } + }, + "example": [] } }, "required": [ @@ -122642,7 +122740,8 @@ "description": "List of suggestions.", "items": { "$ref": "#\/components\/schemas\/domainSuggestion" - } + }, + "example": [] } }, "required": [ @@ -122669,7 +122768,8 @@ "description": "List of domains.", "items": { "$ref": "#\/components\/schemas\/domain" - } + }, + "example": [] } }, "required": [ @@ -122696,7 +122796,8 @@ "description": "List of teams.", "items": { "$ref": "#\/components\/schemas\/organization" - } + }, + "example": [] } }, "required": [ @@ -122723,7 +122824,8 @@ "description": "List of paymentMethods.", "items": { "$ref": "#\/components\/schemas\/paymentMethod" - } + }, + "example": [] } }, "required": [ @@ -122750,7 +122852,8 @@ "description": "List of extensions.", "items": { "$ref": "#\/components\/schemas\/postgresExtension" - } + }, + "example": [] } }, "required": [ @@ -122777,7 +122880,8 @@ "description": "List of regions.", "items": { "$ref": "#\/components\/schemas\/consoleRegion" - } + }, + "example": [] } }, "required": [ @@ -122804,7 +122908,8 @@ "description": "List of apps.", "items": { "$ref": "#\/components\/schemas\/app" - } + }, + "example": [] } }, "required": [ @@ -122831,7 +122936,8 @@ "description": "List of secrets.", "items": { "$ref": "#\/components\/schemas\/appSecret" - } + }, + "example": [] } }, "required": [ @@ -122858,7 +122964,8 @@ "description": "List of scopes.", "items": { "$ref": "#\/components\/schemas\/appScope" - } + }, + "example": [] } }, "required": [ @@ -122885,7 +122992,8 @@ "description": "List of installations.", "items": { "$ref": "#\/components\/schemas\/appInstallation" - } + }, + "example": [] } }, "required": [ @@ -122912,7 +123020,8 @@ "description": "List of keys.", "items": { "$ref": "#\/components\/schemas\/appKey" - } + }, + "example": [] } }, "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 ab7b8bcb5..e9d99abfb 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 @@ -77184,7 +77184,8 @@ "description": "List of rows.", "items": { "$ref": "#\/components\/schemas\/row" - } + }, + "example": [] } }, "required": [ @@ -77211,7 +77212,8 @@ "description": "List of documents.", "items": { "$ref": "#\/components\/schemas\/document" - } + }, + "example": [] } }, "required": [ @@ -77238,7 +77240,8 @@ "description": "List of presences.", "items": { "$ref": "#\/components\/schemas\/presence" - } + }, + "example": [] } }, "required": [ @@ -77265,7 +77268,8 @@ "description": "List of tables.", "items": { "$ref": "#\/components\/schemas\/table" - } + }, + "example": [] } }, "required": [ @@ -77292,7 +77296,8 @@ "description": "List of collections.", "items": { "$ref": "#\/components\/schemas\/collection" - } + }, + "example": [] } }, "required": [ @@ -77319,7 +77324,8 @@ "description": "List of databases.", "items": { "$ref": "#\/components\/schemas\/database" - } + }, + "example": [] } }, "required": [ @@ -77346,7 +77352,8 @@ "description": "List of indexes.", "items": { "$ref": "#\/components\/schemas\/index" - } + }, + "example": [] } }, "required": [ @@ -77373,7 +77380,8 @@ "description": "List of indexes.", "items": { "$ref": "#\/components\/schemas\/columnIndex" - } + }, + "example": [] } }, "required": [ @@ -77400,7 +77408,8 @@ "description": "List of users.", "items": { "$ref": "#\/components\/schemas\/user" - } + }, + "example": [] } }, "required": [ @@ -77427,7 +77436,8 @@ "description": "List of sessions.", "items": { "$ref": "#\/components\/schemas\/session" - } + }, + "example": [] } }, "required": [ @@ -77454,7 +77464,8 @@ "description": "List of identities.", "items": { "$ref": "#\/components\/schemas\/identity" - } + }, + "example": [] } }, "required": [ @@ -77481,7 +77492,8 @@ "description": "List of logs.", "items": { "$ref": "#\/components\/schemas\/log" - } + }, + "example": [] } }, "required": [ @@ -77508,7 +77520,8 @@ "description": "List of files.", "items": { "$ref": "#\/components\/schemas\/file" - } + }, + "example": [] } }, "required": [ @@ -77535,7 +77548,8 @@ "description": "List of buckets.", "items": { "$ref": "#\/components\/schemas\/bucket" - } + }, + "example": [] } }, "required": [ @@ -77562,7 +77576,8 @@ "description": "List of tokens.", "items": { "$ref": "#\/components\/schemas\/resourceToken" - } + }, + "example": [] } }, "required": [ @@ -77589,7 +77604,8 @@ "description": "List of teams.", "items": { "$ref": "#\/components\/schemas\/team" - } + }, + "example": [] } }, "required": [ @@ -77616,7 +77632,8 @@ "description": "List of memberships.", "items": { "$ref": "#\/components\/schemas\/membership" - } + }, + "example": [] } }, "required": [ @@ -77643,7 +77660,8 @@ "description": "List of sites.", "items": { "$ref": "#\/components\/schemas\/site" - } + }, + "example": [] } }, "required": [ @@ -77670,7 +77688,8 @@ "description": "List of functions.", "items": { "$ref": "#\/components\/schemas\/function" - } + }, + "example": [] } }, "required": [ @@ -77697,7 +77716,8 @@ "description": "List of frameworks.", "items": { "$ref": "#\/components\/schemas\/framework" - } + }, + "example": [] } }, "required": [ @@ -77724,7 +77744,8 @@ "description": "List of runtimes.", "items": { "$ref": "#\/components\/schemas\/runtime" - } + }, + "example": [] } }, "required": [ @@ -77751,7 +77772,8 @@ "description": "List of deployments.", "items": { "$ref": "#\/components\/schemas\/deployment" - } + }, + "example": [] } }, "required": [ @@ -77778,7 +77800,8 @@ "description": "List of executions.", "items": { "$ref": "#\/components\/schemas\/execution" - } + }, + "example": [] } }, "required": [ @@ -77805,7 +77828,8 @@ "description": "List of projects.", "items": { "$ref": "#\/components\/schemas\/project" - } + }, + "example": [] } }, "required": [ @@ -77832,7 +77856,8 @@ "description": "List of webhooks.", "items": { "$ref": "#\/components\/schemas\/webhook" - } + }, + "example": [] } }, "required": [ @@ -77859,7 +77884,8 @@ "description": "List of keys.", "items": { "$ref": "#\/components\/schemas\/key" - } + }, + "example": [] } }, "required": [ @@ -77886,7 +77912,8 @@ "description": "List of countries.", "items": { "$ref": "#\/components\/schemas\/country" - } + }, + "example": [] } }, "required": [ @@ -77913,7 +77940,8 @@ "description": "List of continents.", "items": { "$ref": "#\/components\/schemas\/continent" - } + }, + "example": [] } }, "required": [ @@ -77940,7 +77968,8 @@ "description": "List of languages.", "items": { "$ref": "#\/components\/schemas\/language" - } + }, + "example": [] } }, "required": [ @@ -77967,7 +77996,8 @@ "description": "List of currencies.", "items": { "$ref": "#\/components\/schemas\/currency" - } + }, + "example": [] } }, "required": [ @@ -77994,7 +78024,8 @@ "description": "List of phones.", "items": { "$ref": "#\/components\/schemas\/phone" - } + }, + "example": [] } }, "required": [ @@ -78021,7 +78052,8 @@ "description": "List of variables.", "items": { "$ref": "#\/components\/schemas\/variable" - } + }, + "example": [] } }, "required": [ @@ -78048,7 +78080,8 @@ "description": "List of mockNumbers.", "items": { "$ref": "#\/components\/schemas\/mockNumber" - } + }, + "example": [] } }, "required": [ @@ -78141,7 +78174,8 @@ "deny-corporate-email": "#\/components\/schemas\/policyDenyCorporateEmail" } } - } + }, + "example": [] } }, "required": [ @@ -78168,7 +78202,8 @@ "description": "List of templates.", "items": { "$ref": "#\/components\/schemas\/emailTemplate" - } + }, + "example": [] } }, "required": [ @@ -78195,7 +78230,8 @@ "description": "List of rules.", "items": { "$ref": "#\/components\/schemas\/proxyRule" - } + }, + "example": [] } }, "required": [ @@ -78222,7 +78258,8 @@ "description": "List of localeCodes.", "items": { "$ref": "#\/components\/schemas\/localeCode" - } + }, + "example": [] } }, "required": [ @@ -78249,7 +78286,8 @@ "description": "List of providers.", "items": { "$ref": "#\/components\/schemas\/provider" - } + }, + "example": [] } }, "required": [ @@ -78276,7 +78314,8 @@ "description": "List of messages.", "items": { "$ref": "#\/components\/schemas\/message" - } + }, + "example": [] } }, "required": [ @@ -78303,7 +78342,8 @@ "description": "List of topics.", "items": { "$ref": "#\/components\/schemas\/topic" - } + }, + "example": [] } }, "required": [ @@ -78330,7 +78370,8 @@ "description": "List of subscribers.", "items": { "$ref": "#\/components\/schemas\/subscriber" - } + }, + "example": [] } }, "required": [ @@ -78357,7 +78398,8 @@ "description": "List of targets.", "items": { "$ref": "#\/components\/schemas\/target" - } + }, + "example": [] } }, "required": [ @@ -78384,7 +78426,8 @@ "description": "List of transactions.", "items": { "$ref": "#\/components\/schemas\/transaction" - } + }, + "example": [] } }, "required": [ @@ -78411,7 +78454,8 @@ "description": "List of specifications.", "items": { "$ref": "#\/components\/schemas\/specification" - } + }, + "example": [] } }, "required": [ @@ -78438,7 +78482,8 @@ "description": "List of collections.", "items": { "$ref": "#\/components\/schemas\/vectorsdbCollection" - } + }, + "example": [] } }, "required": [ @@ -78465,7 +78510,8 @@ "description": "List of embeddings.", "items": { "$ref": "#\/components\/schemas\/embedding" - } + }, + "example": [] } }, "required": [ @@ -78492,7 +78538,8 @@ "description": "List of insights.", "items": { "$ref": "#\/components\/schemas\/insight" - } + }, + "example": [] } }, "required": [ @@ -78519,7 +78566,8 @@ "description": "List of reports.", "items": { "$ref": "#\/components\/schemas\/report" - } + }, + "example": [] } }, "required": [ @@ -79114,7 +79162,8 @@ } } } - } + }, + "example": [] } }, "required": [ @@ -81542,7 +81591,8 @@ } } } - } + }, + "example": [] } }, "required": [ @@ -86656,7 +86706,8 @@ "description": "Project blocks information", "items": { "$ref": "#\/components\/schemas\/block" - } + }, + "example": [] }, "consoleAccessedAt": { "type": "string", @@ -89292,7 +89343,8 @@ "microsoft": "#\/components\/schemas\/oAuth2Microsoft" } } - } + }, + "example": [] } }, "required": [ @@ -89999,7 +90051,8 @@ "linux": "#\/components\/schemas\/platformLinux" } } - } + }, + "example": [] } }, "required": [ @@ -94341,7 +94394,8 @@ "description": "List of operations.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseOperation" - } + }, + "example": [] } }, "required": [ @@ -94680,7 +94734,8 @@ "description": "Selected projects", "items": { "type": "string" - } + }, + "example": [] } }, "required": [ @@ -95280,7 +95335,8 @@ "description": "List of restorations.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabaseRestoration" - } + }, + "example": [] } }, "required": [ @@ -97734,7 +97790,8 @@ "description": "List of rules.", "items": { "$ref": "#\/components\/schemas\/wafRule" - } + }, + "example": [] } }, "required": [ @@ -97809,7 +97866,8 @@ "description": "List of projects.", "items": { "$ref": "#\/components\/schemas\/oauth2Project" - } + }, + "example": [] } }, "required": [ @@ -97836,7 +97894,8 @@ "description": "List of organizations.", "items": { "$ref": "#\/components\/schemas\/oauth2Organization" - } + }, + "example": [] } }, "required": [ @@ -97863,7 +97922,8 @@ "description": "List of consents.", "items": { "$ref": "#\/components\/schemas\/oauth2Consent" - } + }, + "example": [] } }, "required": [ @@ -97890,7 +97950,8 @@ "description": "List of tokens.", "items": { "$ref": "#\/components\/schemas\/oauth2ConsentToken" - } + }, + "example": [] } }, "required": [ @@ -97917,7 +97978,8 @@ "description": "List of events.", "items": { "$ref": "#\/components\/schemas\/activityEvent" - } + }, + "example": [] } }, "required": [ @@ -97944,7 +98006,8 @@ "description": "List of archives.", "items": { "$ref": "#\/components\/schemas\/backupArchive" - } + }, + "example": [] } }, "required": [ @@ -97971,7 +98034,8 @@ "description": "List of policies.", "items": { "$ref": "#\/components\/schemas\/backupPolicy" - } + }, + "example": [] } }, "required": [ @@ -97998,7 +98062,8 @@ "description": "List of restorations.", "items": { "$ref": "#\/components\/schemas\/backupRestoration" - } + }, + "example": [] } }, "required": [ @@ -98025,7 +98090,8 @@ "description": "List of migrations.", "items": { "$ref": "#\/components\/schemas\/databaseMigration" - } + }, + "example": [] } }, "required": [ @@ -98052,7 +98118,8 @@ "description": "List of databases.", "items": { "$ref": "#\/components\/schemas\/dedicatedDatabase" - } + }, + "example": [] } }, "required": [ @@ -98079,7 +98146,8 @@ "description": "List of apps.", "items": { "$ref": "#\/components\/schemas\/app" - } + }, + "example": [] } }, "required": [ @@ -98106,7 +98174,8 @@ "description": "List of secrets.", "items": { "$ref": "#\/components\/schemas\/appSecret" - } + }, + "example": [] } }, "required": [ @@ -98133,7 +98202,8 @@ "description": "List of scopes.", "items": { "$ref": "#\/components\/schemas\/appScope" - } + }, + "example": [] } }, "required": [ @@ -98160,7 +98230,8 @@ "description": "List of installations.", "items": { "$ref": "#\/components\/schemas\/appInstallation" - } + }, + "example": [] } }, "required": [ @@ -98187,7 +98258,8 @@ "description": "List of keys.", "items": { "$ref": "#\/components\/schemas\/appKey" - } + }, + "example": [] } }, "required": [