From 84e28af3eadcc7f549c5a320281568d8e2ab990b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 12 Oct 2026 17:56:14 +0000 Subject: [PATCH 1/2] chore: update latest API specs with passkeys --- specs/latest/open-api3-latest.json | 8748 +++++++++++++++++++--------- 1 file changed, 6023 insertions(+), 2725 deletions(-) diff --git a/specs/latest/open-api3-latest.json b/specs/latest/open-api3-latest.json index 1405f55c2..87c552cd0 100644 --- a/specs/latest/open-api3-latest.json +++ b/specs/latest/open-api3-latest.json @@ -8552,6 +8552,470 @@ ] } }, + "\/admin\/threats": { + "get": { + "summary": "List threats", + "operationId": "adminListThreats", + "tags": [ + "admin" + ], + "description": "List threats recorded across the platform. Use queries to narrow the list to a project, a resource type, a threat type or a triage status.", + "responses": { + "200": { + "description": "Threats list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/threatList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "group": "threats", + "demo": "admin\/list-threats.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "console", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "console": { + "Project": [] + } + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: projectId, teamId, region, resourceType, resourceId, type, status", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "example": false, + "default": true + }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create threat", + "operationId": "adminCreateThreat", + "tags": [ + "admin" + ], + "description": "Record a threat an operator found on a project resource. The record is of type `manual`; the other types are written by the threats worker's detectors.", + "responses": { + "201": { + "description": "Threat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/threat" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "group": "threats", + "demo": "admin\/create-threat.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "console", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "console": { + "Project": [] + } + } + }, + "security": [ + { + "Project": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "projectId": { + "description": "Project ID.", + "type": "string", + "example": "" + }, + "resourceType": { + "description": "Type of the flagged resource.", + "type": "string", + "example": "projects", + "title": "ThreatResourceType", + "oneOf": [ + { + "type": "string", + "enum": [ + "projects" + ], + "title": "projects" + }, + { + "type": "string", + "enum": [ + "functions" + ], + "title": "functions" + }, + { + "type": "string", + "enum": [ + "sites" + ], + "title": "sites" + }, + { + "type": "string", + "enum": [ + "deployments" + ], + "title": "deployments" + }, + { + "type": "string", + "enum": [ + "databases" + ], + "title": "databases" + }, + { + "type": "string", + "enum": [ + "buckets" + ], + "title": "buckets" + }, + { + "type": "string", + "enum": [ + "files" + ], + "title": "files" + }, + { + "type": "string", + "enum": [ + "users" + ], + "title": "users" + }, + { + "type": "string", + "enum": [ + "mails" + ], + "title": "mails" + }, + { + "type": "string", + "enum": [ + "platforms" + ], + "title": "platforms" + } + ] + }, + "resourceId": { + "description": "ID of the flagged resource.", + "type": "string", + "example": "" + }, + "description": { + "description": "What was found, in the operator's words.", + "type": "string", + "default": "", + "example": "" + }, + "status": { + "description": "Triage status to record the threat with. `open` by default; `resolved` or `dismissed` for a threat already dealt with.", + "type": "string", + "default": "open", + "example": "open", + "title": "ThreatStatus", + "oneOf": [ + { + "type": "string", + "enum": [ + "open" + ], + "title": "open" + }, + { + "type": "string", + "enum": [ + "resolved" + ], + "title": "resolved" + }, + { + "type": "string", + "enum": [ + "dismissed" + ], + "title": "dismissed" + } + ] + } + }, + "required": [ + "projectId", + "resourceType", + "resourceId" + ] + } + } + } + } + } + }, + "\/admin\/threats\/{threatId}": { + "get": { + "summary": "Get threat", + "operationId": "adminGetThreat", + "tags": [ + "admin" + ], + "description": "Get a threat by its unique ID, including the detection details.", + "responses": { + "200": { + "description": "Threat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/threat" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "group": "threats", + "demo": "admin\/get-threat.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "console", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "console": { + "Project": [] + } + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "threatId", + "description": "Threat ID.", + "required": true, + "schema": { + "type": "string", + "example": "" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete threat", + "operationId": "adminDeleteThreat", + "tags": [ + "admin" + ], + "description": "Delete a threat record.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "group": "threats", + "demo": "admin\/delete-threat.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "console", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "console": { + "Project": [] + } + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "threatId", + "description": "Threat ID.", + "required": true, + "schema": { + "type": "string", + "example": "" + }, + "in": "path" + } + ] + } + }, + "\/admin\/threats\/{threatId}\/status": { + "patch": { + "summary": "Update threat status", + "operationId": "adminUpdateThreatStatus", + "tags": [ + "admin" + ], + "description": "Triage a threat: mark it resolved once the resource was dealt with, dismissed for a false positive, or open to revisit it.", + "responses": { + "200": { + "description": "Threat", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/threat" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "group": "threats", + "demo": "admin\/update-threat-status.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "console", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "console": { + "Project": [] + } + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "threatId", + "description": "Threat ID.", + "required": true, + "schema": { + "type": "string", + "example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "description": "Triage status. `resolved` once the resource was dealt with, `dismissed` for a false positive, `open` to reopen.", + "type": "string", + "example": "open", + "title": "ThreatStatus", + "oneOf": [ + { + "type": "string", + "enum": [ + "open" + ], + "title": "open" + }, + { + "type": "string", + "enum": [ + "resolved" + ], + "title": "resolved" + }, + { + "type": "string", + "enum": [ + "dismissed" + ], + "title": "dismissed" + } + ] + } + }, + "required": [ + "status" + ] + } + } + } + } + } + }, "\/affiliates\/links": { "get": { "summary": "List affiliate links", @@ -40281,7 +40745,7 @@ } }, "schedule": { - "description": "Schedule CRON syntax.", + "description": "Schedule CRON syntax. Cannot be combined with interval.", "type": "string", "default": "", "example": "0 0 * * *" @@ -41267,6 +41731,13 @@ "default": 0, "example": 0, "format": "int32" + }, + "interval": { + "description": "Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule.", + "type": "integer", + "default": 0, + "example": 0, + "format": "int32" } }, "required": [ @@ -43178,7 +43649,7 @@ } }, "schedule": { - "description": "Schedule CRON syntax.", + "description": "Schedule CRON syntax. Cannot be combined with interval.", "type": "string", "default": "", "example": "0 0 * * *" @@ -44164,6 +44635,13 @@ "default": 0, "example": 0, "format": "int32" + }, + "interval": { + "description": "Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule. When omitted, the current interval is kept unless schedule is set.", + "type": "integer", + "example": 0, + "format": "int32", + "nullable": true } }, "required": [ @@ -63415,7 +63893,10 @@ "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", "required": false, "schema": { - "type": "string", + "type": "array", + "items": { + "type": "string" + }, "default": [] }, "in": "query" @@ -63588,8 +64069,11 @@ }, "resource": { "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "type": "string", - "default": [] + "type": "array", + "default": [], + "items": { + "type": "string" + } }, "audience": { "description": "Compatibility alias for a single OAuth2 resource indicator URI.", @@ -63706,8 +64190,11 @@ }, "resource": { "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "type": "string", - "default": [] + "type": "array", + "default": [], + "items": { + "type": "string" + } }, "audience": { "description": "Compatibility alias for a single OAuth2 resource indicator URI.", @@ -64472,8 +64959,11 @@ }, "resource": { "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "type": "string", - "default": [] + "type": "array", + "default": [], + "items": { + "type": "string" + } }, "audience": { "description": "Compatibility alias for a single OAuth2 resource indicator URI.", @@ -64926,8 +65416,11 @@ }, "resource": { "description": "RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.", - "type": "string", - "default": [] + "type": "array", + "default": [], + "items": { + "type": "string" + } }, "audience": { "description": "Compatibility alias for a single OAuth2 resource indicator URI.", @@ -86470,6 +86963,14 @@ "description": "Android application ID. Max length: 256 chars.", "type": "string", "example": "" + }, + "fingerprints": { + "description": "SHA-256 fingerprints of the certificates your app is signed with, such as \"14:6D:E9:...:2B:6A\". Passkeys created in the app are accepted when its signature matches one. Find them under App signing in Play Console, or with `.\/gradlew signingReport`.", + "type": "array", + "default": [], + "items": { + "type": "string" + } } }, "required": [ @@ -86490,7 +86991,7 @@ "tags": [ "project" ], - "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.", + "description": "Update an Android platform by its unique ID. Use this endpoint to update the platform's name, application ID or signing certificate fingerprints.", "responses": { "200": { "description": "Platform Android", @@ -86560,6 +87061,14 @@ "description": "Android application ID. Max length: 256 chars.", "type": "string", "example": "" + }, + "fingerprints": { + "description": "SHA-256 fingerprints of the certificates your app is signed with, such as \"14:6D:E9:...:2B:6A\". Passkeys created in the app are accepted when its signature matches one. Find them under App signing in Play Console, or with `.\/gradlew signingReport`. Omit to keep the current list, or pass an empty array to clear it.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "required": [ @@ -87971,7 +88480,7 @@ "tags": [ "project" ], - "description": "Configure the relying party passkeys are bound to. The relying party ID is the domain of your application, and origins are the exact web origins allowed to register and sign in with passkeys. Passkeys stay unavailable until both are set and the passkey auth method is enabled. The relying party ID cannot change while users have passkeys, and any change invalidates ceremonies in progress.", + "description": "Set the relying party ID passkeys are bound to: the domain of your application. Passkeys work on the project's web platforms on that domain or its subdomains, and on the domain itself for Apple apps. A localhost web platform enables passkeys for local development without a relying party ID. The relying party ID cannot change while users have passkeys, and any change invalidates ceremonies in progress.", "responses": { "200": { "description": "Project", @@ -88024,18 +88533,14 @@ "type": "object", "properties": { "rpId": { - "description": "Relying party ID: the domain of your application, such as `example.com`. Use `localhost` for local development.", + "description": "Relying party ID: the domain of your application, such as `example.com`. Use `localhost` for local development, or an empty string to unset it.", "type": "string", "example": "" - }, - "origins": { - "description": "Web origins allowed to use passkeys, such as `https:\/\/example.com` or `https:\/\/app.example.com`. Each must be HTTPS on the relying party ID or one of its subdomains, without a path. HTTP is only allowed for `localhost`. Maximum of 10 origins.", - "type": "array", - "items": { - "type": "string" - } } - } + }, + "required": [ + "rpId" + ] } } } @@ -88252,28 +88757,109 @@ "type": "object", "properties": { "enabled": { - "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.", + "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.", + "type": "boolean", + "example": false + } + }, + "required": [ + "enabled" + ] + } + } + } + } + } + }, + "\/project\/policies\/password-pwned": { + "patch": { + "summary": "Update password pwned policy", + "operationId": "projectUpdatePasswordPwnedPolicy", + "tags": [ + "project" + ], + "description": "Updating this policy allows you to control if passwords are checked against the Have I Been Pwned breach database. When enabled, every password a user signs up, signs in or resets with is checked and the result is recorded on the user as `passwordPwned`. On its own the policy only records. Enable `users` to reject a breached password when a user signs up or sets a new password, and `sessions` to refuse a sign-in with a breached password until it is reset. Only the first five characters of the password hash are ever shared with the service. Options left out keep their current value.", + "responses": { + "200": { + "description": "Project", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/project" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "group": "policies", + "demo": "project\/update-password-pwned-policy.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "policies.write", + "project.policies.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "console": { + "Project": [] + }, + "server": { + "Project": [], + "Key": [] + } + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "description": "Toggle password pwned policy. Set to true to check passwords against known data breaches and record the result on the user, or false to never check. Default is true. On its own this only records; use `users` and `sessions` to block. When changing this policy, existing passwords remain valid.", + "type": "boolean", + "example": false + }, + "sessions": { + "description": "Whether a sign-in with a breached password is refused until the password is reset. Default is false, which allows the sign-in and only records the result.", + "type": "boolean", + "example": false + }, + "users": { + "description": "Whether a breached password is rejected when a user signs up or sets a new password. Default is false, which allows the password and only records the result.", "type": "boolean", "example": false } - }, - "required": [ - "enabled" - ] + } } } } } } }, - "\/project\/policies\/password-pwned": { + "\/project\/policies\/password-rotation": { "patch": { - "summary": "Update password pwned policy", - "operationId": "projectUpdatePasswordPwnedPolicy", + "summary": "Update password rotation policy", + "operationId": "projectUpdatePasswordRotationPolicy", "tags": [ "project" ], - "description": "Updating this policy allows you to control if passwords are checked against the Have I Been Pwned breach database. When enabled, every password a user signs up, signs in or resets with is checked and the result is recorded on the user as `passwordPwned`. On its own the policy only records. Enable `users` to reject a breached password when a user signs up or sets a new password, and `sessions` to refuse a sign-in with a breached password until it is reset. Only the first five characters of the password hash are ever shared with the service. Options left out keep their current value.", + "description": "Require a password reset when an email\/password sign-in uses a password older than the configured maximum age. Options left out keep their current value.", "responses": { "200": { "description": "Project", @@ -88289,7 +88875,7 @@ "deprecated": false, "x-appwrite": { "group": "policies", - "demo": "project\/update-password-pwned-policy.md", + "demo": "project\/update-password-rotation-policy.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -88326,19 +88912,15 @@ "type": "object", "properties": { "enabled": { - "description": "Toggle password pwned policy. Set to true to check passwords against known data breaches and record the result on the user, or false to never check. Default is true. On its own this only records; use `users` and `sessions` to block. When changing this policy, existing passwords remain valid.", + "description": "Enable password rotation. Disabled by default.", "type": "boolean", "example": false }, - "sessions": { - "description": "Whether a sign-in with a breached password is refused until the password is reset. Default is false, which allows the sign-in and only records the result.", - "type": "boolean", - "example": false - }, - "users": { - "description": "Whether a breached password is rejected when a user signs up or sets a new password. Default is false, which allows the password and only records the result.", - "type": "boolean", - "example": false + "maxAge": { + "description": "Maximum password age in seconds. Minimum allowed value is 86400 seconds (1 day), and maximum is 10 years, which is 315360000 seconds. Defaults to 1 year, which is 31536000 seconds.", + "type": "integer", + "example": 86400, + "format": "int32" } } } @@ -88823,7 +89405,7 @@ "description": "Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.", "responses": { "200": { - "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Strength, or Policy Password Personal Data, or Policy Password Pwned, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy, or Policy MFA Factors, or Policy Deny Aliased Email, or Policy Deny Disposable Email, or Policy Deny Free Email, or Policy Deny Corporate Email, or Policy Passkey", + "description": "Policy Password Dictionary, or Policy Password History, or Policy Password Strength, or Policy Password Personal Data, or Policy Password Pwned, or Policy Password Rotation, or Policy Session Alert, or Policy Session Duration, or Policy Session Invalidation, or Policy Session Limit, or Policy User Limit, or Policy Membership Privacy, or Policy MFA Factors, or Policy Deny Aliased Email, or Policy Deny Disposable Email, or Policy Deny Free Email, or Policy Deny Corporate Email, or Policy Passkey", "content": { "application\/json": { "schema": { @@ -88843,6 +89425,9 @@ { "$ref": "#\/components\/schemas\/policyPasswordPwned" }, + { + "$ref": "#\/components\/schemas\/policyPasswordRotation" + }, { "$ref": "#\/components\/schemas\/policySessionAlert" }, @@ -88888,6 +89473,7 @@ "password-strength": "#\/components\/schemas\/policyPasswordStrength", "password-personal-data": "#\/components\/schemas\/policyPasswordPersonalData", "password-pwned": "#\/components\/schemas\/policyPasswordPwned", + "password-rotation": "#\/components\/schemas\/policyPasswordRotation", "session-alert": "#\/components\/schemas\/policySessionAlert", "session-duration": "#\/components\/schemas\/policySessionDuration", "session-invalidation": "#\/components\/schemas\/policySessionInvalidation", @@ -88943,7 +89529,7 @@ "parameters": [ { "name": "policyId", - "description": "Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, password-pwned, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email, passkey.", + "description": "Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, password-pwned, password-rotation, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email, passkey.", "required": true, "schema": { "type": "string", @@ -88985,6 +89571,13 @@ ], "title": "password-pwned" }, + { + "type": "string", + "enum": [ + "password-rotation" + ], + "title": "password-rotation" + }, { "type": "string", "enum": [ @@ -92840,8 +93433,9 @@ "example": "" }, "schedule": { - "description": "Schedule CRON expression.", + "description": "Schedule CRON expression. Cannot be combined with interval.", "type": "string", + "default": "", "example": "0 0 * * *" }, "active": { @@ -92855,12 +93449,18 @@ "type": "object", "default": {}, "example": {} + }, + "interval": { + "description": "Minutes between runs, for function schedules only. Use 0 to disable. Cannot be combined with schedule.", + "type": "integer", + "default": 0, + "example": 0, + "format": "int32" } }, "required": [ "resourceType", - "resourceId", - "schedule" + "resourceId" ] } } @@ -113224,6 +113824,12 @@ "schema": { "type": "object", "properties": { + "membershipId": { + "description": "Membership 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.", + "type": "string", + "default": "", + "example": "" + }, "email": { "description": "Email of the new team member.", "type": "string", @@ -124953,8 +125559,11 @@ }, "conditions": { "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "type": "string", - "default": [] + "type": "array", + "default": [], + "items": { + "type": "string" + } } }, "required": [ @@ -125088,7 +125697,10 @@ }, "conditions": { "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "type": "string", + "type": "array", + "items": { + "type": "string" + }, "nullable": true } } @@ -125202,8 +125814,11 @@ }, "conditions": { "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "type": "string", - "default": [] + "type": "array", + "default": [], + "items": { + "type": "string" + } }, "difficulty": { "description": "Challenge difficulty from 1 (easiest) to 5 (hardest). Higher values demand more client-side proof-of-work.", @@ -125357,7 +125972,10 @@ }, "conditions": { "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "type": "string", + "type": "array", + "items": { + "type": "string" + }, "nullable": true }, "difficulty": { @@ -125479,8 +126097,11 @@ }, "conditions": { "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "type": "string", - "default": [] + "type": "array", + "default": [], + "items": { + "type": "string" + } } }, "required": [ @@ -125614,7 +126235,10 @@ }, "conditions": { "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "type": "string", + "type": "array", + "items": { + "type": "string" + }, "nullable": true } } @@ -125753,8 +126377,11 @@ }, "conditions": { "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "type": "string", - "default": [] + "type": "array", + "default": [], + "items": { + "type": "string" + } } }, "required": [ @@ -125919,7 +126546,10 @@ }, "conditions": { "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "type": "string", + "type": "array", + "items": { + "type": "string" + }, "nullable": true } } @@ -126038,8 +126668,11 @@ }, "conditions": { "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "type": "string", - "default": [] + "type": "array", + "default": [], + "items": { + "type": "string" + } } }, "required": [ @@ -126190,7 +126823,10 @@ }, "conditions": { "description": "Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.", - "type": "string", + "type": "array", + "items": { + "type": "string" + }, "nullable": true } } @@ -126210,11 +126846,37 @@ "description": "Get a WAF rule by its ID.\n", "responses": { "200": { - "description": "WafRule", + "description": "WafRuleBypass, or WafRuleDeny, or WafRuleChallenge, or WafRuleRateLimit, or WafRuleRedirect", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/wafRule" + "oneOf": [ + { + "$ref": "#\/components\/schemas\/wafRuleBypass" + }, + { + "$ref": "#\/components\/schemas\/wafRuleDeny" + }, + { + "$ref": "#\/components\/schemas\/wafRuleChallenge" + }, + { + "$ref": "#\/components\/schemas\/wafRuleRateLimit" + }, + { + "$ref": "#\/components\/schemas\/wafRuleRedirect" + } + ], + "discriminator": { + "propertyName": "action", + "mapping": { + "bypass": "#\/components\/schemas\/wafRuleBypass", + "deny": "#\/components\/schemas\/wafRuleDeny", + "challenge": "#\/components\/schemas\/wafRuleChallenge", + "rateLimit": "#\/components\/schemas\/wafRuleRateLimit", + "redirect": "#\/components\/schemas\/wafRuleRedirect" + } + } } } } @@ -126489,13 +127151,13 @@ "example": false }, "authUsername": { - "description": "Webhook HTTP user. Max length: 256 chars.", + "description": "Webhook HTTP user. Max length: 255 chars.", "type": "string", "default": "", "example": "" }, "authPassword": { - "description": "Webhook HTTP password. Max length: 256 chars.", + "description": "Webhook HTTP password. Max length: 2048 chars.", "type": "string", "default": "", "example": "password", @@ -126683,13 +127345,13 @@ "example": false }, "authUsername": { - "description": "Webhook HTTP user. Max length: 256 chars.", + "description": "Webhook HTTP user. Max length: 255 chars.", "type": "string", "default": "", "example": "" }, "authPassword": { - "description": "Webhook HTTP password. Max length: 256 chars. Omit to keep the current password; it is cleared when the URL changes or TLS verification is disabled.", + "description": "Webhook HTTP password. Max length: 2048 chars. Omit to keep the current password; it is cleared when the URL changes or TLS verification is disabled.", "type": "string", "example": "password", "format": "password", @@ -126981,6 +127643,10 @@ "name": "manager", "description": "" }, + { + "name": "admin", + "description": "" + }, { "name": "regions", "description": "" @@ -127020,10 +127686,6 @@ { "name": "growth", "description": "The Growth service allows you to contact the Appwrite team and record self-hosted installations." - }, - { - "name": "admin", - "description": "" } ], "components": { @@ -127042,7 +127704,8 @@ "type": "integer", "description": "Total number of rows that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "rows": { "type": "array", @@ -127070,7 +127733,8 @@ "type": "integer", "description": "Total number of documents that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "documents": { "type": "array", @@ -127098,7 +127762,8 @@ "type": "integer", "description": "Total number of presences that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "presences": { "type": "array", @@ -127126,7 +127791,8 @@ "type": "integer", "description": "Total number of tables that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "tables": { "type": "array", @@ -127154,7 +127820,8 @@ "type": "integer", "description": "Total number of collections that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "collections": { "type": "array", @@ -127182,7 +127849,8 @@ "type": "integer", "description": "Total number of databases that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "databases": { "type": "array", @@ -127210,7 +127878,8 @@ "type": "integer", "description": "Total number of indexes that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "indexes": { "type": "array", @@ -127238,7 +127907,8 @@ "type": "integer", "description": "Total number of indexes that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "indexes": { "type": "array", @@ -127266,7 +127936,8 @@ "type": "integer", "description": "Total number of users that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "users": { "type": "array", @@ -127294,7 +127965,8 @@ "type": "integer", "description": "Total number of sessions that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "sessions": { "type": "array", @@ -127322,7 +127994,8 @@ "type": "integer", "description": "Total number of identities that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "identities": { "type": "array", @@ -127350,7 +128023,8 @@ "type": "integer", "description": "Total number of notifications that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "notifications": { "type": "array", @@ -127378,7 +128052,8 @@ "type": "integer", "description": "Total number of files that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "files": { "type": "array", @@ -127406,7 +128081,8 @@ "type": "integer", "description": "Total number of buckets that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "buckets": { "type": "array", @@ -127434,7 +128110,8 @@ "type": "integer", "description": "Total number of tokens that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "tokens": { "type": "array", @@ -127462,7 +128139,8 @@ "type": "integer", "description": "Total number of teams that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "teams": { "type": "array", @@ -127490,7 +128168,8 @@ "type": "integer", "description": "Total number of memberships that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "memberships": { "type": "array", @@ -127518,7 +128197,8 @@ "type": "integer", "description": "Total number of sites that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "sites": { "type": "array", @@ -127546,7 +128226,8 @@ "type": "integer", "description": "Total number of templates that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "templates": { "type": "array", @@ -127574,7 +128255,8 @@ "type": "integer", "description": "Total number of functions that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "functions": { "type": "array", @@ -127602,7 +128284,8 @@ "type": "integer", "description": "Total number of templates that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "templates": { "type": "array", @@ -127630,7 +128313,8 @@ "type": "integer", "description": "Total number of installations that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "installations": { "type": "array", @@ -127658,7 +128342,8 @@ "type": "integer", "description": "Total number of frameworkProviderRepositories that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "frameworkProviderRepositories": { "type": "array", @@ -127671,7 +128356,8 @@ "type": { "type": "string", "description": "Provider repository list type.", - "example": "framework" + "example": "framework", + "default": "framework" } }, "required": [ @@ -127693,7 +128379,8 @@ "type": "integer", "description": "Total number of runtimeProviderRepositories that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "runtimeProviderRepositories": { "type": "array", @@ -127706,7 +128393,8 @@ "type": { "type": "string", "description": "Provider repository list type.", - "example": "runtime" + "example": "runtime", + "default": "runtime" } }, "required": [ @@ -127727,27 +128415,32 @@ "$id": { "type": "string", "description": "VCS (Version Control System) namespace ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "VCS (Version Control System) namespace display name.", - "example": "Appwrite" + "example": "Appwrite", + "default": "" }, "path": { "type": "string", "description": "VCS (Version Control System) namespace path, used to filter repositories by namespace.", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "type": { "type": "string", "description": "Namespace type. Either the user's personal namespace or a group\/organization.", - "example": "user" + "example": "user", + "default": "" }, "avatarUrl": { "type": "string", "description": "Namespace avatar URL.", - "example": "https:\/\/example.com\/avatar.png" + "example": "https:\/\/example.com\/avatar.png", + "default": "" } }, "required": [ @@ -127773,7 +128466,8 @@ "type": "integer", "description": "Total number of namespaces that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "namespaces": { "type": "array", @@ -127801,7 +128495,8 @@ "type": "integer", "description": "Total number of branches that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "branches": { "type": "array", @@ -127829,7 +128524,8 @@ "type": "integer", "description": "Total number of frameworks that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "frameworks": { "type": "array", @@ -127857,7 +128553,8 @@ "type": "integer", "description": "Total number of runtimes that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "runtimes": { "type": "array", @@ -127885,7 +128582,8 @@ "type": "integer", "description": "Total number of deployments that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "deployments": { "type": "array", @@ -127913,7 +128611,8 @@ "type": "integer", "description": "Total number of executions that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "executions": { "type": "array", @@ -127941,7 +128640,8 @@ "type": "integer", "description": "Total number of projects that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "projects": { "type": "array", @@ -127969,7 +128669,8 @@ "type": "integer", "description": "Total number of webhooks that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "webhooks": { "type": "array", @@ -127997,7 +128698,8 @@ "type": "integer", "description": "Total number of keys that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "keys": { "type": "array", @@ -128025,7 +128727,8 @@ "type": "integer", "description": "Total number of countries that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "countries": { "type": "array", @@ -128053,7 +128756,8 @@ "type": "integer", "description": "Total number of continents that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "continents": { "type": "array", @@ -128081,7 +128785,8 @@ "type": "integer", "description": "Total number of languages that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "languages": { "type": "array", @@ -128109,7 +128814,8 @@ "type": "integer", "description": "Total number of currencies that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "currencies": { "type": "array", @@ -128137,7 +128843,8 @@ "type": "integer", "description": "Total number of phones that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "phones": { "type": "array", @@ -128165,7 +128872,8 @@ "type": "integer", "description": "Total number of variables that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "variables": { "type": "array", @@ -128193,7 +128901,8 @@ "type": "integer", "description": "Total number of mockNumbers that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "mockNumbers": { "type": "array", @@ -128221,7 +128930,8 @@ "type": "integer", "description": "Total number of policies in the given project.", "format": "int32", - "example": 10 + "example": 10, + "default": 0 }, "policies": { "type": "array", @@ -128243,6 +128953,9 @@ { "$ref": "#\/components\/schemas\/policyPasswordPwned" }, + { + "$ref": "#\/components\/schemas\/policyPasswordRotation" + }, { "$ref": "#\/components\/schemas\/policySessionAlert" }, @@ -128288,6 +129001,7 @@ "password-strength": "#\/components\/schemas\/policyPasswordStrength", "password-personal-data": "#\/components\/schemas\/policyPasswordPersonalData", "password-pwned": "#\/components\/schemas\/policyPasswordPwned", + "password-rotation": "#\/components\/schemas\/policyPasswordRotation", "session-alert": "#\/components\/schemas\/policySessionAlert", "session-duration": "#\/components\/schemas\/policySessionDuration", "session-invalidation": "#\/components\/schemas\/policySessionInvalidation", @@ -128323,7 +129037,8 @@ "type": "integer", "description": "Total number of templates that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "templates": { "type": "array", @@ -128351,7 +129066,8 @@ "type": "integer", "description": "Total number of rules that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "rules": { "type": "array", @@ -128379,7 +129095,8 @@ "type": "integer", "description": "Total number of schedules that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "schedules": { "type": "array", @@ -128427,7 +129144,8 @@ "type": "integer", "description": "Total number of localeCodes that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "localeCodes": { "type": "array", @@ -128455,7 +129173,8 @@ "type": "integer", "description": "Total number of providers that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "providers": { "type": "array", @@ -128483,7 +129202,8 @@ "type": "integer", "description": "Total number of messages that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "messages": { "type": "array", @@ -128511,7 +129231,8 @@ "type": "integer", "description": "Total number of topics that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "topics": { "type": "array", @@ -128539,7 +129260,8 @@ "type": "integer", "description": "Total number of subscribers that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "subscribers": { "type": "array", @@ -128567,7 +129289,8 @@ "type": "integer", "description": "Total number of targets that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "targets": { "type": "array", @@ -128595,7 +129318,8 @@ "type": "integer", "description": "Total number of transactions that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "transactions": { "type": "array", @@ -128623,7 +129347,8 @@ "type": "integer", "description": "Total number of migrations that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "migrations": { "type": "array", @@ -128651,7 +129376,8 @@ "type": "integer", "description": "Total number of specifications that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "specifications": { "type": "array", @@ -128679,7 +129405,8 @@ "type": "integer", "description": "Total number of contents that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "contents": { "type": "array", @@ -128707,7 +129434,8 @@ "type": "integer", "description": "Total number of collections that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "collections": { "type": "array", @@ -128735,7 +129463,8 @@ "type": "integer", "description": "Total number of embeddings that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "embeddings": { "type": "array", @@ -128763,7 +129492,8 @@ "type": "integer", "description": "Total number of insights that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "insights": { "type": "array", @@ -128791,7 +129521,8 @@ "type": "integer", "description": "Total number of reports that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "reports": { "type": "array", @@ -128818,27 +129549,32 @@ "$id": { "type": "string", "description": "Database ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "Database name.", - "example": "My Database" + "example": "My Database", + "default": "" }, "$createdAt": { "type": "string", "description": "Database creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Database update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "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.", - "example": false + "example": false, + "default": true }, "type": { "description": "Database type.", @@ -128895,7 +129631,8 @@ ], "title": "mongodb" } - ] + ], + "default": "legacy" }, "status": { "description": "Dedicated database lifecycle status. Null when the database has no valid dedicated backing.", @@ -129100,13 +129837,15 @@ "model": { "type": "string", "description": "Embedding model used to generate embeddings.", - "example": "nomic-embed-text" + "example": "nomic-embed-text", + "default": "" }, "dimension": { "type": "integer", "description": "Number of dimensions for each embedding vector.", "format": "int32", - "example": 768 + "example": 768, + "default": 0 }, "embedding": { "type": "array", @@ -129119,12 +129858,14 @@ 0.01, 0.02, 0.03 - ] + ], + "default": [] }, "error": { "type": "string", "description": "Error message if embedding generation fails. Empty string if no error.", - "example": "Error message" + "example": "Error message", + "default": "" } }, "required": [ @@ -129151,17 +129892,20 @@ "$id": { "type": "string", "description": "Collection ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Collection creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Collection update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -129176,22 +129920,26 @@ "databaseId": { "type": "string", "description": "Database ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "Collection name.", - "example": "My Collection" + "example": "My Collection", + "default": "" }, "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.", - "example": false + "example": false, + "default": true }, "documentSecurity": { "type": "boolean", "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "example": true + "example": true, + "default": false }, "attributes": { "type": "array", @@ -129598,13 +130346,15 @@ "type": "integer", "description": "Maximum document size in bytes. Returns 0 when no limit applies.", "format": "int32", - "example": 65535 + "example": 65535, + "default": 0 }, "bytesUsed": { "type": "integer", "description": "Currently used document size in bytes based on defined attributes.", "format": "int32", - "example": 1500 + "example": 1500, + "default": 0 } }, "required": [ @@ -129646,7 +130396,8 @@ "type": "integer", "description": "Total number of attributes in the given collection.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "attributes": { "type": "array", @@ -130058,12 +130809,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -130111,34 +130864,40 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "size": { "type": "integer", "description": "Attribute size.", "format": "int32", - "example": 128 + "example": 128, + "default": 0 }, "default": { "type": "string", @@ -130150,6 +130909,7 @@ "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", "example": false, + "default": false, "nullable": true } }, @@ -130184,12 +130944,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "count" + "example": "count", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "integer" + "example": "integer", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -130237,28 +130999,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "min": { "type": "integer", @@ -130312,12 +131079,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "count" + "example": "count", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "bigint" + "example": "bigint", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -130365,28 +131134,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "min": { "type": "integer", @@ -130440,12 +131214,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "percentageCompleted" + "example": "percentageCompleted", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "double" + "example": "double", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -130493,28 +131269,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "min": { "type": "number", @@ -130568,12 +131349,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "isEnabled" + "example": "isEnabled", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "boolean" + "example": "boolean", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -130621,28 +131404,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "boolean", @@ -130679,12 +131467,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "userEmail" + "example": "userEmail", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -130732,33 +131522,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "format": { "type": "string", "description": "String format.", - "example": "email" + "example": "email", + "default": "email" }, "default": { "type": "string", @@ -130797,12 +131593,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "status" + "example": "status", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -130850,28 +131648,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "elements": { "type": "array", @@ -130886,7 +131689,8 @@ "format": { "type": "string", "description": "String format.", - "example": "enum" + "example": "enum", + "default": "enum" }, "default": { "type": "string", @@ -130927,12 +131731,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "ipAddress" + "example": "ipAddress", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -130980,33 +131786,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "format": { "type": "string", "description": "String format.", - "example": "ip" + "example": "ip", + "default": "ip" }, "default": { "type": "string", @@ -131045,12 +131857,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "githubUrl" + "example": "githubUrl", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -131098,33 +131912,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "format": { "type": "string", "description": "String format.", - "example": "url" + "example": "url", + "default": "url" }, "default": { "type": "string", @@ -131163,12 +131983,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "birthDay" + "example": "birthDay", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "datetime" + "example": "datetime", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -131216,28 +132038,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "format": { "type": "string", @@ -131281,12 +132108,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -131334,28 +132163,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "relatedCollection": { "type": "string", @@ -131365,27 +132199,32 @@ "relationType": { "type": "string", "description": "The type of the relationship.", - "example": "oneToOne|oneToMany|manyToOne|manyToMany" + "example": "oneToOne|oneToMany|manyToOne|manyToMany", + "default": "" }, "twoWay": { "type": "boolean", "description": "Is the relationship two-way?", - "example": false + "example": false, + "default": false }, "twoWayKey": { "type": "string", "description": "The key of the two-way relationship.", - "example": "string" + "example": "string", + "default": "" }, "onDelete": { "type": "string", "description": "How deleting the parent document will propagate to child documents.", - "example": "restrict|cascade|setNull" + "example": "restrict|cascade|setNull", + "default": "restrict" }, "side": { "type": "string", "description": "Whether this is the parent or child side of the relationship", - "example": "parent|child" + "example": "parent|child", + "default": "" } }, "required": [ @@ -131427,12 +132266,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -131480,28 +132321,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "array", @@ -131548,12 +132394,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -131601,28 +132449,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "array", @@ -131684,12 +132537,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -131737,28 +132592,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "array", @@ -131847,12 +132707,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -131900,34 +132762,40 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "size": { "type": "integer", "description": "Attribute size.", "format": "int32", - "example": 128 + "example": 128, + "default": 0 }, "default": { "type": "string", @@ -131939,6 +132807,7 @@ "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", "example": false, + "default": false, "nullable": true } }, @@ -131973,12 +132842,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -132026,28 +132897,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "string", @@ -132059,6 +132935,7 @@ "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", "example": false, + "default": false, "nullable": true } }, @@ -132091,12 +132968,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -132144,28 +133023,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "string", @@ -132177,6 +133061,7 @@ "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", "example": false, + "default": false, "nullable": true } }, @@ -132209,12 +133094,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -132262,28 +133149,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "string", @@ -132295,6 +133187,7 @@ "type": "boolean", "description": "Defines whether this attribute is encrypted or not.", "example": false, + "default": false, "nullable": true } }, @@ -132327,17 +133220,20 @@ "$id": { "type": "string", "description": "Collection ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Collection creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Collection update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -132352,22 +133248,26 @@ "databaseId": { "type": "string", "description": "Database ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "Collection name.", - "example": "My Collection" + "example": "My Collection", + "default": "" }, "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.", - "example": false + "example": false, + "default": true }, "documentSecurity": { "type": "boolean", "description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "example": true + "example": true, + "default": false }, "attributes": { "type": "array", @@ -132403,19 +133303,22 @@ "type": "integer", "description": "Maximum document size in bytes. Returns 0 when no limit applies.", "format": "int32", - "example": 65535 + "example": 65535, + "default": 0 }, "bytesUsed": { "type": "integer", "description": "Currently used document size in bytes based on defined attributes.", "format": "int32", - "example": 1500 + "example": 1500, + "default": 0 }, "dimension": { "type": "integer", "description": "Embedding dimension.", "format": "int32", - "example": 1536 + "example": 1536, + "default": 0 } }, "required": [ @@ -132458,12 +133361,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -132511,28 +133416,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -132562,12 +133472,14 @@ "key": { "type": "string", "description": "Attribute Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Attribute type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -132615,34 +133527,40 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an attribute.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is attribute required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is attribute an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "size": { "type": "integer", "description": "Vector dimensions.", "format": "int32", - "example": 1536 + "example": 1536, + "default": 0 } }, "required": [ @@ -132674,17 +133592,20 @@ "$id": { "type": "string", "description": "Table ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Table creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Table update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -132699,22 +133620,26 @@ "databaseId": { "type": "string", "description": "Database ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "Table name.", - "example": "My Table" + "example": "My Table", + "default": "" }, "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.", - "example": false + "example": false, + "default": true }, "rowSecurity": { "type": "boolean", "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "example": true + "example": true, + "default": false }, "columns": { "type": "array", @@ -133121,13 +134046,15 @@ "type": "integer", "description": "Maximum row size in bytes. Returns 0 when no limit applies.", "format": "int32", - "example": 65535 + "example": 65535, + "default": 0 }, "bytesUsed": { "type": "integer", "description": "Currently used row size in bytes based on defined columns.", "format": "int32", - "example": 1500 + "example": 1500, + "default": 0 } }, "required": [ @@ -133169,7 +134096,8 @@ "type": "integer", "description": "Total number of columns in the given table.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "columns": { "type": "array", @@ -133581,12 +134509,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -133634,34 +134564,40 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "size": { "type": "integer", "description": "Column size.", "format": "int32", - "example": 128 + "example": 128, + "default": 0 }, "default": { "type": "string", @@ -133673,6 +134609,7 @@ "type": "boolean", "description": "Defines whether this column is encrypted or not.", "example": false, + "default": false, "nullable": true } }, @@ -133707,12 +134644,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "count" + "example": "count", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "integer" + "example": "integer", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -133760,28 +134699,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "min": { "type": "integer", @@ -133835,12 +134779,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "count" + "example": "count", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "bigint" + "example": "bigint", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -133888,28 +134834,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "min": { "type": "integer", @@ -133963,12 +134914,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "percentageCompleted" + "example": "percentageCompleted", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "double" + "example": "double", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -134016,28 +134969,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "min": { "type": "number", @@ -134091,12 +135049,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "isEnabled" + "example": "isEnabled", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "boolean" + "example": "boolean", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -134144,28 +135104,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "boolean", @@ -134202,12 +135167,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "userEmail" + "example": "userEmail", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -134255,33 +135222,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "format": { "type": "string", "description": "String format.", - "example": "email" + "example": "email", + "default": "email" }, "default": { "type": "string", @@ -134320,12 +135293,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "status" + "example": "status", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -134373,28 +135348,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "elements": { "type": "array", @@ -134409,7 +135389,8 @@ "format": { "type": "string", "description": "String format.", - "example": "enum" + "example": "enum", + "default": "enum" }, "default": { "type": "string", @@ -134450,12 +135431,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "ipAddress" + "example": "ipAddress", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -134503,33 +135486,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "format": { "type": "string", "description": "String format.", - "example": "ip" + "example": "ip", + "default": "ip" }, "default": { "type": "string", @@ -134568,12 +135557,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "githubUrl" + "example": "githubUrl", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -134621,33 +135612,39 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "format": { "type": "string", "description": "String format.", - "example": "url" + "example": "url", + "default": "url" }, "default": { "type": "string", @@ -134686,12 +135683,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "birthDay" + "example": "birthDay", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "datetime" + "example": "datetime", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -134739,28 +135738,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "format": { "type": "string", @@ -134804,12 +135808,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -134857,28 +135863,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "relatedTable": { "type": "string", @@ -134888,27 +135899,32 @@ "relationType": { "type": "string", "description": "The type of the relationship.", - "example": "oneToOne|oneToMany|manyToOne|manyToMany" + "example": "oneToOne|oneToMany|manyToOne|manyToMany", + "default": "" }, "twoWay": { "type": "boolean", "description": "Is the relationship two-way?", - "example": false + "example": false, + "default": false }, "twoWayKey": { "type": "string", "description": "The key of the two-way relationship.", - "example": "string" + "example": "string", + "default": "" }, "onDelete": { "type": "string", "description": "How deleting the parent document will propagate to child documents.", - "example": "restrict|cascade|setNull" + "example": "restrict|cascade|setNull", + "default": "restrict" }, "side": { "type": "string", "description": "Whether this is the parent or child side of the relationship", - "example": "parent|child" + "example": "parent|child", + "default": "" } }, "required": [ @@ -134950,12 +135966,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -135003,28 +136021,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "array", @@ -135071,12 +136094,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -135124,28 +136149,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "array", @@ -135207,12 +136237,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -135260,28 +136292,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "array", @@ -135370,12 +136407,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -135423,34 +136462,40 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "size": { "type": "integer", "description": "Column size.", "format": "int32", - "example": 128 + "example": 128, + "default": 0 }, "default": { "type": "string", @@ -135462,6 +136507,7 @@ "type": "boolean", "description": "Defines whether this column is encrypted or not.", "example": false, + "default": false, "nullable": true } }, @@ -135496,12 +136542,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -135549,28 +136597,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "string", @@ -135582,6 +136635,7 @@ "type": "boolean", "description": "Defines whether this column is encrypted or not.", "example": false, + "default": false, "nullable": true } }, @@ -135614,12 +136668,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -135667,28 +136723,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "string", @@ -135700,6 +136761,7 @@ "type": "boolean", "description": "Defines whether this column is encrypted or not.", "example": false, + "default": false, "nullable": true } }, @@ -135732,12 +136794,14 @@ "key": { "type": "string", "description": "Column Key.", - "example": "fullName" + "example": "fullName", + "default": "" }, "type": { "type": "string", "description": "Column type.", - "example": "string" + "example": "string", + "default": "" }, "status": { "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -135785,28 +136849,33 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an column.", - "example": "string" + "example": "string", + "default": "" }, "required": { "type": "boolean", "description": "Is column required?", - "example": true + "example": true, + "default": false }, "array": { "type": "boolean", "description": "Is column an array?", "example": false, + "default": false, "nullable": true }, "$createdAt": { "type": "string", "description": "Column creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Column update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "default": { "type": "string", @@ -135818,6 +136887,7 @@ "type": "boolean", "description": "Defines whether this column is encrypted or not.", "example": false, + "default": false, "nullable": true } }, @@ -135850,27 +136920,32 @@ "$id": { "type": "string", "description": "Index ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Index creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Index update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "key": { "type": "string", "description": "Index key.", - "example": "index1" + "example": "index1", + "default": "" }, "type": { "type": "string", "description": "Index type.", - "example": "primary" + "example": "primary", + "default": "" }, "status": { "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", @@ -135917,7 +136992,8 @@ "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "example": "string" + "example": "string", + "default": "" }, "attributes": { "type": "array", @@ -135925,7 +137001,8 @@ "items": { "type": "string" }, - "example": [] + "example": [], + "default": [] }, "lengths": { "type": "array", @@ -135934,7 +137011,8 @@ "type": "integer", "format": "int32" }, - "example": [] + "example": [], + "default": [] }, "orders": { "type": "array", @@ -135943,6 +137021,7 @@ "type": "string" }, "example": [], + "default": [], "nullable": true } }, @@ -135977,37 +137056,44 @@ "$id": { "type": "string", "description": "Index ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Index creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Index update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "key": { "type": "string", "description": "Index Key.", - "example": "index1" + "example": "index1", + "default": "" }, "type": { "type": "string", "description": "Index type.", - "example": "primary" + "example": "primary", + "default": "" }, "status": { "type": "string", "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`", - "example": "available" + "example": "available", + "default": "" }, "error": { "type": "string", "description": "Error message. Displays error generated on failure of creating or deleting an index.", - "example": "string" + "example": "string", + "default": "" }, "columns": { "type": "array", @@ -136015,7 +137101,8 @@ "items": { "type": "string" }, - "example": [] + "example": [], + "default": [] }, "lengths": { "type": "array", @@ -136024,7 +137111,8 @@ "type": "integer", "format": "int32" }, - "example": [] + "example": [], + "default": [] }, "orders": { "type": "array", @@ -136033,6 +137121,7 @@ "type": "string" }, "example": [], + "default": [], "nullable": true } }, @@ -136067,35 +137156,41 @@ "$id": { "type": "string", "description": "Row ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$sequence": { "type": "string", "description": "Row sequence ID.", "readOnly": true, - "example": "1" + "example": "1", + "default": "" }, "$tableId": { "type": "string", "description": "Table ID.", "readOnly": true, - "example": "5e5ea5c15117e" + "example": "5e5ea5c15117e", + "default": "" }, "$databaseId": { "type": "string", "description": "Database ID.", "readOnly": true, - "example": "5e5ea5c15117e" + "example": "5e5ea5c15117e", + "default": "" }, "$createdAt": { "type": "string", "description": "Row creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Row update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -136137,35 +137232,41 @@ "$id": { "type": "string", "description": "Document ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$sequence": { "type": "string", "description": "Document sequence ID.", "readOnly": true, - "example": "1" + "example": "1", + "default": "" }, "$collectionId": { "type": "string", "description": "Collection ID.", "readOnly": true, - "example": "5e5ea5c15117e" + "example": "5e5ea5c15117e", + "default": "" }, "$databaseId": { "type": "string", "description": "Database ID.", "readOnly": true, - "example": "5e5ea5c15117e" + "example": "5e5ea5c15117e", + "default": "" }, "$createdAt": { "type": "string", "description": "Document creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Document update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -136212,17 +137313,20 @@ "$id": { "type": "string", "description": "Presence ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Presence creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Presence update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -136237,7 +137341,8 @@ "userId": { "type": "string", "description": "User ID.", - "example": "674af8f3e12a5f9ac0be" + "example": "674af8f3e12a5f9ac0be", + "default": "" }, "status": { "type": "string", @@ -136248,7 +137353,8 @@ "source": { "type": "string", "description": "Presence source.", - "example": "HTTP" + "example": "HTTP", + "default": "" }, "expiresAt": { "type": "string", @@ -136296,33 +137402,39 @@ "$id": { "type": "string", "description": "User ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "User creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "User update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "User name.", - "example": "John Doe" + "example": "John Doe", + "default": "" }, "password": { "type": "string", "description": "Hashed user password.", "example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE", + "default": "", "nullable": true }, "hash": { "type": "string", "description": "Password hashing algorithm.", "example": "argon2", + "default": "", "nullable": true }, "hashOptions": { @@ -136373,12 +137485,14 @@ "registration": { "type": "string", "description": "User registration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "status": { "type": "boolean", "description": "User status. Pass `true` for enabled and `false` for disabled.", - "example": true + "example": true, + "default": true }, "labels": { "type": "array", @@ -136388,32 +137502,38 @@ }, "example": [ "vip" - ] + ], + "default": [] }, "passwordUpdate": { "type": "string", "description": "Password update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "email": { "type": "string", "description": "User email address.", - "example": "john@appwrite.io" + "example": "john@appwrite.io", + "default": "" }, "phone": { "type": "string", "description": "User phone number in E.164 format.", - "example": "+4930901820" + "example": "+4930901820", + "default": "" }, "emailVerification": { "type": "boolean", "description": "Email verification status.", - "example": true + "example": true, + "default": false }, "emailCanonical": { "type": "string", "description": "Canonical form of the user email address.", "example": "john@appwrite.io", + "default": "", "nullable": true }, "emailIsFree": { @@ -136449,12 +137569,14 @@ "phoneVerification": { "type": "boolean", "description": "Phone verification status.", - "example": true + "example": true, + "default": false }, "mfa": { "type": "boolean", "description": "Multi factor authentication status.", - "example": true + "example": true, + "default": false }, "prefs": { "type": "object", @@ -136480,12 +137602,14 @@ "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "impersonator": { "type": "boolean", "description": "Whether the user can impersonate other users.", "example": false, + "default": false, "nullable": true }, "impersonatorUserId": { @@ -136555,7 +137679,8 @@ "type": { "type": "string", "description": "Algo type.", - "example": "md5" + "example": "md5", + "default": "md5" } }, "required": [ @@ -136572,7 +137697,8 @@ "type": { "type": "string", "description": "Algo type.", - "example": "sha" + "example": "sha", + "default": "sha" } }, "required": [ @@ -136589,7 +137715,8 @@ "type": { "type": "string", "description": "Algo type.", - "example": "phpass" + "example": "phpass", + "default": "phpass" } }, "required": [ @@ -136606,7 +137733,8 @@ "type": { "type": "string", "description": "Algo type.", - "example": "bcrypt" + "example": "bcrypt", + "default": "bcrypt" } }, "required": [ @@ -136623,31 +137751,36 @@ "type": { "type": "string", "description": "Algo type.", - "example": "scrypt" + "example": "scrypt", + "default": "scrypt" }, "costCpu": { "type": "integer", "description": "CPU complexity of computed hash.", "format": "int32", - "example": 8 + "example": 8, + "default": 8 }, "costMemory": { "type": "integer", "description": "Memory complexity of computed hash.", "format": "int32", - "example": 14 + "example": 14, + "default": 14 }, "costParallel": { "type": "integer", "description": "Parallelization of computed hash.", "format": "int32", - "example": 1 + "example": 1, + "default": 1 }, "length": { "type": "integer", "description": "Length used to compute hash.", "format": "int32", - "example": 64 + "example": 64, + "default": 64 } }, "required": [ @@ -136672,22 +137805,26 @@ "type": { "type": "string", "description": "Algo type.", - "example": "scryptMod" + "example": "scryptMod", + "default": "scryptMod" }, "salt": { "type": "string", "description": "Salt used to compute hash.", - "example": "UxLMreBr6tYyjQ==" + "example": "UxLMreBr6tYyjQ==", + "default": "" }, "saltSeparator": { "type": "string", "description": "Separator used to compute hash.", - "example": "Bw==" + "example": "Bw==", + "default": "" }, "signerKey": { "type": "string", "description": "Key used to compute hash.", - "example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==" + "example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ==", + "default": "" } }, "required": [ @@ -136710,25 +137847,29 @@ "type": { "type": "string", "description": "Algo type.", - "example": "argon2" + "example": "argon2", + "default": "argon2" }, "memoryCost": { "type": "integer", "description": "Memory used to compute hash.", "format": "int32", - "example": 65536 + "example": 65536, + "default": 0 }, "timeCost": { "type": "integer", "description": "Amount of time consumed to compute hash", "format": "int32", - "example": 4 + "example": 4, + "default": 0 }, "threads": { "type": "integer", "description": "Number of threads used to compute hash.", "format": "int32", - "example": 3 + "example": 3, + "default": 0 } }, "required": [ @@ -136751,32 +137892,38 @@ "$id": { "type": "string", "description": "User ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "User creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "User update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "User name.", - "example": "John Doe" + "example": "John Doe", + "default": "" }, "registration": { "type": "string", "description": "User registration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "status": { "type": "boolean", "description": "User status. Pass `true` for enabled and `false` for disabled.", - "example": true + "example": true, + "default": true }, "labels": { "type": "array", @@ -136786,32 +137933,38 @@ }, "example": [ "vip" - ] + ], + "default": [] }, "passwordUpdate": { "type": "string", "description": "Password update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "email": { "type": "string", "description": "User email address.", - "example": "john@appwrite.io" + "example": "john@appwrite.io", + "default": "" }, "phone": { "type": "string", "description": "User phone number in E.164 format.", - "example": "+4930901820" + "example": "+4930901820", + "default": "" }, "emailVerification": { "type": "boolean", "description": "Email verification status.", - "example": true + "example": true, + "default": false }, "emailCanonical": { "type": "string", "description": "Canonical form of the user email address.", "example": "john@appwrite.io", + "default": "", "nullable": true }, "emailIsFree": { @@ -136847,12 +138000,14 @@ "phoneVerification": { "type": "boolean", "description": "Phone verification status.", - "example": true + "example": true, + "default": false }, "mfa": { "type": "boolean", "description": "Multi factor authentication status.", - "example": true + "example": true, + "default": false }, "prefs": { "type": "object", @@ -136878,12 +138033,14 @@ "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "impersonator": { "type": "boolean", "description": "Whether the user can impersonate other users.", "example": false, + "default": false, "nullable": true }, "impersonatorUserId": { @@ -136960,132 +138117,158 @@ "$id": { "type": "string", "description": "Session ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Session creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Session update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "User ID.", - "example": "5e5bb8c16897e" + "example": "5e5bb8c16897e", + "default": "" }, "expire": { "type": "string", "description": "Session expiration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "provider": { "type": "string", "description": "Session Provider.", - "example": "email" + "example": "email", + "default": "" }, "providerUid": { "type": "string", "description": "Session Provider User ID.", - "example": "user@example.com" + "example": "user@example.com", + "default": "" }, "providerAccessToken": { "type": "string", "description": "Session Provider Access Token.", - "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "default": "" }, "providerAccessTokenExpiry": { "type": "string", "description": "The date of when the access token expires in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "providerRefreshToken": { "type": "string", "description": "Session Provider Refresh Token.", - "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "default": "" }, "ip": { "type": "string", "description": "IP in use when the session was created.", - "example": "127.0.0.1" + "example": "127.0.0.1", + "default": "" }, "osCode": { "type": "string", "description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).", - "example": "Mac" + "example": "Mac", + "default": "" }, "osName": { "type": "string", "description": "Operating system name.", - "example": "Mac" + "example": "Mac", + "default": "" }, "osVersion": { "type": "string", "description": "Operating system version.", - "example": "Mac" + "example": "Mac", + "default": "" }, "clientType": { "type": "string", "description": "Client type.", - "example": "browser" + "example": "browser", + "default": "" }, "clientCode": { "type": "string", "description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).", - "example": "CM" + "example": "CM", + "default": "" }, "clientName": { "type": "string", "description": "Client name.", - "example": "Chrome Mobile iOS" + "example": "Chrome Mobile iOS", + "default": "" }, "clientVersion": { "type": "string", "description": "Client version.", - "example": "84.0" + "example": "84.0", + "default": "" }, "clientEngine": { "type": "string", "description": "Client engine name.", - "example": "WebKit" + "example": "WebKit", + "default": "" }, "clientEngineVersion": { "type": "string", "description": "Client engine name.", - "example": "605.1.15" + "example": "605.1.15", + "default": "" }, "deviceName": { "type": "string", "description": "Device name.", - "example": "smartphone" + "example": "smartphone", + "default": "" }, "deviceBrand": { "type": "string", "description": "Device brand name.", - "example": "Google" + "example": "Google", + "default": "" }, "deviceModel": { "type": "string", "description": "Device model name.", - "example": "Nexus 5" + "example": "Nexus 5", + "default": "" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "example": "US" + "example": "US", + "default": "" }, "countryName": { "type": "string", "description": "Country name.", - "example": "United States" + "example": "United States", + "default": "" }, "current": { "type": "boolean", "description": "Returns true if this the current user session.", - "example": true + "example": true, + "default": false }, "factors": { "type": "array", @@ -137095,17 +138278,20 @@ }, "example": [ "email" - ] + ], + "default": [] }, "secret": { "type": "string", "description": "Secret used to authenticate the user. Only included if the request was made with an API key", - "example": "5e5bb8c16897e" + "example": "5e5bb8c16897e", + "default": "" }, "mfaUpdatedAt": { "type": "string", "description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -137180,57 +138366,68 @@ "$id": { "type": "string", "description": "Identity ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Identity creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Identity update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "User ID.", - "example": "5e5bb8c16897e" + "example": "5e5bb8c16897e", + "default": "" }, "provider": { "type": "string", "description": "Identity Provider.", - "example": "email" + "example": "email", + "default": "" }, "providerUid": { "type": "string", "description": "ID of the User in the Identity Provider.", - "example": "5e5bb8c16897e" + "example": "5e5bb8c16897e", + "default": "" }, "providerEmail": { "type": "string", "description": "Email of the User in the Identity Provider.", - "example": "user@example.com" + "example": "user@example.com", + "default": "" }, "providerAccessToken": { "type": "string", "description": "Identity Provider Access Token.", - "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "default": "" }, "providerAccessTokenExpiry": { "type": "string", "description": "The date of when the access token expires in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "providerRefreshToken": { "type": "string", "description": "Identity Provider Refresh Token.", - "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3" + "example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3", + "default": "" }, "providerIdToken": { "type": "string", "description": "Identity Provider ID token (JWT) from the most recent native sign-in. Empty for identities created through the browser OAuth2 flow.", - "example": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjBhYzNmMWQwNWExYjhlN2YifQ.eyJzdWIiOiIxMTAxNjk0ODQ0NzQzODYyNzYzMzQifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "example": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjBhYzNmMWQwNWExYjhlN2YifQ.eyJzdWIiOiIxMTAxNjk0ODQ0NzQzODYyNzYzMzQifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", + "default": "" } }, "required": [ @@ -137267,74 +138464,88 @@ "$id": { "type": "string", "description": "Notification ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Notification creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Notification update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "messageId": { "type": "string", "description": "Stable message ID used for dedup.", "example": "session.create", + "default": "", "nullable": true }, "type": { "type": "string", "description": "Notification type: info, warning, error.", - "example": "info" + "example": "info", + "default": "info" }, "channel": { "type": "string", "description": "Channel: email, sms, push, console, webhook.", - "example": "email" + "example": "email", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type this notification is addressed to.", - "example": "users" + "example": "users", + "default": "" }, "resourceId": { "type": "string", "description": "Resource ID this notification is addressed to.", - "example": "5e5bb8c16897e" + "example": "5e5bb8c16897e", + "default": "" }, "parentResourceType": { "type": "string", "description": "Parent resource type for the notification.", - "example": "projects" + "example": "projects", + "default": "" }, "parentResourceId": { "type": "string", "description": "Parent resource ID for the notification.", - "example": "5e5bb8c16897e" + "example": "5e5bb8c16897e", + "default": "" }, "projectId": { "type": "string", "description": "Project the notification pertains to.", "example": "5e5bb8c16897e", + "default": "", "nullable": true }, "title": { "type": "string", "description": "Notification title.", - "example": "New sign-in detected" + "example": "New sign-in detected", + "default": "" }, "body": { "type": "string", "description": "Notification body.", - "example": "A new device signed in to your account." + "example": "A new device signed in to your account.", + "default": "" }, "read": { "type": "boolean", "description": "Whether the notification has been read.", "example": false, + "default": false, "nullable": true }, "firstSeen": { @@ -137389,32 +138600,38 @@ "$id": { "type": "string", "description": "Token ID.", - "example": "bb8ea5c16897e" + "example": "bb8ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "User ID.", - "example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8", + "default": "" }, "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.", - "example": "" + "example": "", + "default": "" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "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.", - "example": "Golden Fox" + "example": "Golden Fox", + "default": "" } }, "required": [ @@ -137441,7 +138658,8 @@ "jwt": { "type": "string", "description": "JWT encoded string.", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", + "default": "" } }, "required": [ @@ -137458,37 +138676,44 @@ "ip": { "type": "string", "description": "User IP address.", - "example": "127.0.0.1" + "example": "127.0.0.1", + "default": "" }, "countryCode": { "type": "string", "description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format", - "example": "US" + "example": "US", + "default": "" }, "country": { "type": "string", "description": "Country name. This field support localization.", - "example": "United States" + "example": "United States", + "default": "" }, "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.", - "example": "NA" + "example": "NA", + "default": "" }, "continent": { "type": "string", "description": "Continent name. This field support localization.", - "example": "North America" + "example": "North America", + "default": "" }, "eu": { "type": "boolean", "description": "True if country is part of the European Union.", - "example": false + "example": false, + "default": false }, "currency": { "type": "string", "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format", - "example": "USD" + "example": "USD", + "default": "" }, "city": { "type": "string", @@ -137596,12 +138821,14 @@ "code": { "type": "string", "description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)", - "example": "en-us" + "example": "en-us", + "default": "" }, "name": { "type": "string", "description": "Locale name", - "example": "US" + "example": "US", + "default": "" } }, "required": [ @@ -137620,22 +138847,26 @@ "$id": { "type": "string", "description": "File ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "bucketId": { "type": "string", "description": "Bucket ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "File creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "File update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -137645,66 +138876,78 @@ }, "example": [ "read(\"any\")" - ] + ], + "default": [] }, "name": { "type": "string", "description": "File name.", - "example": "Pink.png" + "example": "Pink.png", + "default": "" }, "folder": { "type": "string", "description": "Virtual folder containing the file, with a trailing slash. Empty for the bucket root.", - "example": "photos\/2026\/" + "example": "photos\/2026\/", + "default": "" }, "key": { "type": "string", "description": "Full virtual path of the file: the folder followed by the file name.", - "example": "photos\/2026\/Pink.png" + "example": "photos\/2026\/Pink.png", + "default": "" }, "signature": { "type": "string", "description": "File MD5 signature.", - "example": "5d529fd02b544198ae075bd57c1762bb" + "example": "5d529fd02b544198ae075bd57c1762bb", + "default": "" }, "mimeType": { "type": "string", "description": "File mime type.", - "example": "image\/png" + "example": "image\/png", + "default": "" }, "sizeOriginal": { "type": "integer", "description": "File original size in bytes.", "format": "int32", - "example": 17890 + "example": 17890, + "default": 0 }, "sizeActual": { "type": "integer", "description": "File actual stored size in bytes after compression and\/or encryption.", "format": "int32", - "example": 12345 + "example": 12345, + "default": 0 }, "chunksTotal": { "type": "integer", "description": "Total number of chunks available", "format": "int32", - "example": 17890 + "example": 17890, + "default": 0 }, "chunksUploaded": { "type": "integer", "description": "Total number of chunks uploaded", "format": "int32", - "example": 17890 + "example": 17890, + "default": 0 }, "encryption": { "type": "boolean", "description": "Whether file contents are encrypted at rest.", - "example": true + "example": true, + "default": false }, "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).", - "example": "gzip" + "example": "gzip", + "default": "none" } }, "required": [ @@ -137753,17 +138996,20 @@ "$id": { "type": "string", "description": "Bucket ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Bucket creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Bucket update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -137773,28 +139019,33 @@ }, "example": [ "read(\"any\")" - ] + ], + "default": [] }, "fileSecurity": { "type": "boolean", "description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "example": true + "example": true, + "default": false }, "name": { "type": "string", "description": "Bucket name.", - "example": "Documents" + "example": "Documents", + "default": "" }, "enabled": { "type": "boolean", "description": "Bucket enabled.", - "example": false + "example": false, + "default": true }, "maximumFileSize": { "type": "integer", "description": "Maximum file size supported.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "allowedFileExtensions": { "type": "array", @@ -137805,33 +139056,39 @@ "example": [ "jpg", "png" - ] + ], + "default": [] }, "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).", - "example": "gzip" + "example": "gzip", + "default": "" }, "encryption": { "type": "boolean", "description": "Bucket is encrypted.", - "example": false + "example": false, + "default": true }, "antivirus": { "type": "boolean", "description": "Virus scanning is enabled.", - "example": false + "example": false, + "default": true }, "transformations": { "type": "boolean", "description": "Image transformations are enabled.", - "example": false + "example": false, + "default": true }, "totalSize": { "type": "integer", "description": "Total size of this bucket in bytes.", "format": "int32", - "example": 128 + "example": 128, + "default": 0 } }, "required": [ @@ -137879,37 +139136,44 @@ "$id": { "type": "string", "description": "Token ID.", - "example": "bb8ea5c16897e" + "example": "bb8ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "resourceId": { "type": "string", "description": "Resource ID.", - "example": "5e5ea5c168bb8:5e5ea5c168bb8" + "example": "5e5ea5c168bb8:5e5ea5c168bb8", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type.", - "example": "files" + "example": "files", + "default": "" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "secret": { "type": "string", "description": "JWT encoded string.", - "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", + "default": "" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -137938,28 +139202,33 @@ "$id": { "type": "string", "description": "Team ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Team creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Team update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Team name.", - "example": "VIP" + "example": "VIP", + "default": "" }, "total": { "type": "integer", "description": "Total number of team members.", "format": "int32", - "example": 7 + "example": 7, + "default": 0 }, "prefs": { "type": "object", @@ -138002,72 +139271,86 @@ "$id": { "type": "string", "description": "Membership ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Membership creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Membership update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "User ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "userName": { "type": "string", "description": "User name. Hide this attribute by toggling membership privacy in the Console.", - "example": "John Doe" + "example": "John Doe", + "default": "" }, "userEmail": { "type": "string", "description": "User email address. Hide this attribute by toggling membership privacy in the Console.", - "example": "john@appwrite.io" + "example": "john@appwrite.io", + "default": "" }, "userPhone": { "type": "string", "description": "User phone number. Hide this attribute by toggling membership privacy in the Console.", - "example": "+1 555 555 5555" + "example": "+1 555 555 5555", + "default": "" }, "teamId": { "type": "string", "description": "Team ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "teamName": { "type": "string", "description": "Team name.", - "example": "VIP" + "example": "VIP", + "default": "" }, "invited": { "type": "string", "description": "Date, the user has been invited to join the team in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "joined": { "type": "string", "description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "confirm": { "type": "boolean", "description": "User confirmation status, true if the user has joined the team or false otherwise.", - "example": false + "example": false, + "default": 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.", - "example": false + "example": false, + "default": false }, "userAccessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "roles": { "type": "array", @@ -138077,7 +139360,8 @@ }, "example": [ "owner" - ] + ], + "default": [] } }, "required": [ @@ -138124,83 +139408,99 @@ "$id": { "type": "string", "description": "Site ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Site creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Site update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Site name.", - "example": "My Site" + "example": "My Site", + "default": "" }, "enabled": { "type": "boolean", "description": "Site enabled.", - "example": false + "example": false, + "default": true }, "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.", - "example": false + "example": false, + "default": true }, "logging": { "type": "boolean", "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "example": false + "example": false, + "default": true }, "framework": { "type": "string", "description": "Site framework.", - "example": "react" + "example": "react", + "default": "" }, "deploymentRetention": { "type": "integer", "description": "How many days to keep the non-active deployments before they will be automatically deleted.", "format": "int32", - "example": 7 + "example": 7, + "default": 0 }, "deploymentId": { "type": "string", "description": "Site's active deployment ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "deploymentCreatedAt": { "type": "string", "description": "Active deployment creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "deploymentScreenshotLight": { "type": "string", "description": "Screenshot of active deployment with light theme preference file ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "deploymentScreenshotDark": { "type": "string", "description": "Screenshot of active deployment with dark theme preference file ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "latestDeploymentId": { "type": "string", "description": "Site's latest deployment ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "latestDeploymentCreatedAt": { "type": "string", "description": "Latest deployment creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "latestDeploymentStatus": { "type": "string", "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "example": "ready" + "example": "ready", + "default": "" }, "scopes": { "type": "array", @@ -138210,7 +139510,8 @@ }, "example": [ "users.read" - ] + ], + "default": [] }, "vars": { "type": "array", @@ -138224,52 +139525,62 @@ "type": "integer", "description": "Site request timeout in seconds.", "format": "int32", - "example": 300 + "example": 300, + "default": 15 }, "installCommand": { "type": "string", "description": "The install command used to install the site dependencies.", - "example": "npm install" + "example": "npm install", + "default": "" }, "buildCommand": { "type": "string", "description": "The build command used to build the site.", - "example": "npm run build" + "example": "npm run build", + "default": "" }, "startCommand": { "type": "string", "description": "Custom command to use when starting site runtime.", - "example": "node custom-server.mjs" + "example": "node custom-server.mjs", + "default": "" }, "outputDirectory": { "type": "string", "description": "The directory where the site build output is located.", - "example": "build" + "example": "build", + "default": "" }, "installationId": { "type": "string", "description": "Site VCS (Version Control System) installation id.", - "example": "6m40at4ejk5h2u9s1hboo" + "example": "6m40at4ejk5h2u9s1hboo", + "default": "" }, "providerRepositoryId": { "type": "string", "description": "VCS (Version Control System) Repository ID", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "providerBranch": { "type": "string", "description": "VCS (Version Control System) branch name", - "example": "main" + "example": "main", + "default": "" }, "providerRootDirectory": { "type": "string", "description": "Path to site in VCS (Version Control System) repository", - "example": "sites\/helloWorld" + "example": "sites\/helloWorld", + "default": "" }, "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", - "example": false + "example": false, + "default": false }, "providerBranches": { "type": "array", @@ -138280,7 +139591,8 @@ "example": [ "main", "feat\/*" - ] + ], + "default": [] }, "providerPaths": { "type": "array", @@ -138291,22 +139603,26 @@ "example": [ "src\/**", "!docs\/**" - ] + ], + "default": [] }, "buildSpecification": { "type": "string", "description": "Machine specification for deployment builds.", - "example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb", + "default": "s-1vcpu-512mb" }, "runtimeSpecification": { "type": "string", "description": "Machine specification for SSR executions.", - "example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb", + "default": "s-1vcpu-512mb" }, "buildRuntime": { "type": "string", "description": "Site build runtime.", - "example": "node-22" + "example": "node-22", + "default": "" }, "adapter": { "type": "string", @@ -138407,33 +139723,39 @@ "key": { "type": "string", "description": "Site Template ID.", - "example": "starter" + "example": "starter", + "default": "" }, "name": { "type": "string", "description": "Site Template Name.", - "example": "Starter site" + "example": "Starter site", + "default": "" }, "tagline": { "type": "string", "description": "Short description of template", - "example": "Minimal web app integrating with Appwrite." + "example": "Minimal web app integrating with Appwrite.", + "default": "" }, "demoUrl": { "type": "string", "description": "URL hosting a template demo.", "example": "https:\/\/nextjs-starter.appwrite.network\/", + "default": "", "nullable": true }, "screenshotDark": { "type": "string", "description": "File URL with preview screenshot in dark theme preference.", - "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", + "default": "" }, "screenshotLight": { "type": "string", "description": "File URL with preview screenshot in light theme preference.", - "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", + "default": "" }, "useCases": { "type": "array", @@ -138443,7 +139765,8 @@ }, "example": [ "Starter" - ] + ], + "default": [] }, "frameworks": { "type": "array", @@ -138456,22 +139779,26 @@ "vcsProvider": { "type": "string", "description": "VCS (Version Control System) Provider.", - "example": "github" + "example": "github", + "default": "" }, "providerRepositoryId": { "type": "string", "description": "VCS (Version Control System) Repository ID", - "example": "templates" + "example": "templates", + "default": "" }, "providerOwner": { "type": "string", "description": "VCS (Version Control System) Owner.", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "providerVersion": { "type": "string", "description": "VCS (Version Control System) branch version (tag).", - "example": "main" + "example": "main", + "default": "" }, "variables": { "type": "array", @@ -138519,42 +139846,50 @@ "key": { "type": "string", "description": "Parent framework key.", - "example": "sveltekit" + "example": "sveltekit", + "default": "" }, "name": { "type": "string", "description": "Framework Name.", - "example": "SvelteKit" + "example": "SvelteKit", + "default": "" }, "installCommand": { "type": "string", "description": "The install command used to install the dependencies.", - "example": "npm install" + "example": "npm install", + "default": "" }, "buildCommand": { "type": "string", "description": "The build command used to build the deployment.", - "example": "npm run build" + "example": "npm run build", + "default": "" }, "outputDirectory": { "type": "string", "description": "The output directory to store the build output.", - "example": ".\/build" + "example": ".\/build", + "default": "" }, "providerRootDirectory": { "type": "string", "description": "Path to site in VCS (Version Control System) repository", - "example": ".\/svelte-kit\/starter" + "example": ".\/svelte-kit\/starter", + "default": "" }, "buildRuntime": { "type": "string", "description": "Runtime used during build step of template.", - "example": "node-22" + "example": "node-22", + "default": "" }, "adapter": { "type": "string", "description": "Site framework runtime", - "example": "ssr" + "example": "ssr", + "default": "" }, "fallbackFile": { "type": "string", @@ -138592,17 +139927,20 @@ "$id": { "type": "string", "description": "Function ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Function creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Function update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "execute": { "type": "array", @@ -138612,63 +139950,75 @@ }, "example": [ "users" - ] + ], + "default": [] }, "name": { "type": "string", "description": "Function name.", - "example": "My Function" + "example": "My Function", + "default": "" }, "enabled": { "type": "boolean", "description": "Function enabled.", - "example": false + "example": false, + "default": true }, "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.", - "example": false + "example": false, + "default": true }, "logging": { "type": "boolean", "description": "When disabled, executions will exclude logs and errors, and will be slightly faster.", - "example": false + "example": false, + "default": true }, "runtime": { "type": "string", "description": "Function execution and build runtime.", - "example": "python-3.8" + "example": "python-3.8", + "default": "" }, "deploymentRetention": { "type": "integer", "description": "How many days to keep the non-active deployments before they will be automatically deleted.", "format": "int32", - "example": 7 + "example": 7, + "default": 0 }, "deploymentId": { "type": "string", "description": "Function's active deployment ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "deploymentCreatedAt": { "type": "string", "description": "Active deployment creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "latestDeploymentId": { "type": "string", "description": "Function's latest deployment ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "latestDeploymentCreatedAt": { "type": "string", "description": "Latest deployment creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "latestDeploymentStatus": { "type": "string", "description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".", - "example": "ready" + "example": "ready", + "default": "" }, "scopes": { "type": "array", @@ -138678,7 +140028,8 @@ }, "example": [ "users.read" - ] + ], + "default": [] }, "vars": { "type": "array", @@ -138696,58 +140047,77 @@ }, "example": [ "account.create" - ] + ], + "default": [] }, "schedule": { "type": "string", "description": "Function execution schedule in CRON format.", - "example": "5 4 * * *" + "example": "5 4 * * *", + "default": "" + }, + "interval": { + "type": "integer", + "description": "Minutes between scheduled executions. 0 when the function has no interval.", + "format": "int32", + "example": 60, + "default": 0, + "nullable": true }, "timeout": { "type": "integer", "description": "Function execution timeout in seconds.", "format": "int32", - "example": 300 + "example": 300, + "default": 15 }, "entrypoint": { "type": "string", "description": "The entrypoint file used to execute the deployment.", - "example": "index.js" + "example": "index.js", + "default": "" }, "commands": { "type": "string", "description": "The build command used to build the deployment.", - "example": "npm install" + "example": "npm install", + "default": "" }, "version": { "type": "string", "description": "Version of Open Runtimes used for the function.", - "example": "v2" + "example": "v2", + "default": "v5" }, "installationId": { "type": "string", "description": "Function VCS (Version Control System) installation id.", - "example": "6m40at4ejk5h2u9s1hboo" + "example": "6m40at4ejk5h2u9s1hboo", + "default": "" }, "providerRepositoryId": { "type": "string", "description": "VCS (Version Control System) Repository ID", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "providerBranch": { "type": "string", "description": "VCS (Version Control System) branch name", - "example": "main" + "example": "main", + "default": "" }, "providerRootDirectory": { "type": "string", "description": "Path to function in VCS (Version Control System) repository", - "example": "functions\/helloWorld" + "example": "functions\/helloWorld", + "default": "" }, "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", - "example": false + "example": false, + "default": false }, "providerBranches": { "type": "array", @@ -138758,7 +140128,8 @@ "example": [ "main", "feat\/*" - ] + ], + "default": [] }, "providerPaths": { "type": "array", @@ -138769,17 +140140,20 @@ "example": [ "src\/**", "!docs\/**" - ] + ], + "default": [] }, "buildSpecification": { "type": "string", "description": "Machine specification for deployment builds.", - "example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb", + "default": "s-1vcpu-512mb" }, "runtimeSpecification": { "type": "string", "description": "Machine specification for executions.", - "example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb", + "default": "s-1vcpu-512mb" } }, "required": [ @@ -138836,6 +140210,7 @@ "vars": [], "events": "account.create", "schedule": "5 4 * * *", + "interval": 60, "timeout": 300, "entrypoint": "index.js", "commands": "npm install", @@ -138864,22 +140239,26 @@ "icon": { "type": "string", "description": "Function Template Icon.", - "example": "icon-lightning-bolt" + "example": "icon-lightning-bolt", + "default": "" }, "id": { "type": "string", "description": "Function Template ID.", - "example": "starter" + "example": "starter", + "default": "" }, "name": { "type": "string", "description": "Function Template Name.", - "example": "Starter function" + "example": "Starter function", + "default": "" }, "tagline": { "type": "string", "description": "Function Template Tagline.", - "example": "A simple function to get started." + "example": "A simple function to get started.", + "default": "" }, "permissions": { "type": "array", @@ -138889,7 +140268,8 @@ }, "example": [ "any" - ] + ], + "default": [] }, "events": { "type": "array", @@ -138899,18 +140279,21 @@ }, "example": [ "account.create" - ] + ], + "default": [] }, "cron": { "type": "string", "description": "Function execution schedult in CRON format.", - "example": "0 0 * * *" + "example": "0 0 * * *", + "default": "" }, "timeout": { "type": "integer", "description": "Function execution timeout in seconds.", "format": "int32", - "example": 300 + "example": 300, + "default": 15 }, "useCases": { "type": "array", @@ -138920,7 +140303,8 @@ }, "example": [ "Starter" - ] + ], + "default": [] }, "runtimes": { "type": "array", @@ -138933,27 +140317,32 @@ "instructions": { "type": "string", "description": "Function Template Instructions.", - "example": "For documentation and instructions check out ." + "example": "For documentation and instructions check out .", + "default": "" }, "vcsProvider": { "type": "string", "description": "VCS (Version Control System) Provider.", - "example": "github" + "example": "github", + "default": "" }, "providerRepositoryId": { "type": "string", "description": "VCS (Version Control System) Repository ID", - "example": "templates" + "example": "templates", + "default": "" }, "providerOwner": { "type": "string", "description": "VCS (Version Control System) Owner.", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "providerVersion": { "type": "string", "description": "VCS (Version Control System) branch version (tag).", - "example": "main" + "example": "main", + "default": "" }, "variables": { "type": "array", @@ -138971,7 +140360,8 @@ }, "example": [ "users.read" - ] + ], + "default": [] } }, "required": [ @@ -139020,22 +140410,26 @@ "name": { "type": "string", "description": "Runtime Name.", - "example": "node-19.0" + "example": "node-19.0", + "default": "" }, "commands": { "type": "string", "description": "The build command used to build the deployment.", - "example": "npm install" + "example": "npm install", + "default": "" }, "entrypoint": { "type": "string", "description": "The entrypoint file used to execute the deployment.", - "example": "index.js" + "example": "index.js", + "default": "" }, "providerRootDirectory": { "type": "string", "description": "Path to function in VCS (Version Control System) repository", - "example": "node\/starter" + "example": "node\/starter", + "default": "" } }, "required": [ @@ -139058,37 +140452,44 @@ "name": { "type": "string", "description": "Variable Name.", - "example": "APPWRITE_DATABASE_ID" + "example": "APPWRITE_DATABASE_ID", + "default": "" }, "description": { "type": "string", "description": "Variable Description.", - "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.", + "default": "" }, "value": { "type": "string", "description": "Variable Value.", - "example": "512" + "example": "512", + "default": "" }, "secret": { "type": "boolean", "description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.", - "example": false + "example": false, + "default": false }, "placeholder": { "type": "string", "description": "Variable Placeholder.", - "example": "64a55...7b912" + "example": "64a55...7b912", + "default": "" }, "required": { "type": "boolean", "description": "Is the variable required?", - "example": false + "example": false, + "default": false }, "type": { "type": "string", "description": "Variable Type.", - "example": "password" + "example": "password", + "default": "" } }, "required": [ @@ -139117,17 +140518,20 @@ "$id": { "type": "string", "description": "Function ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Function creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Function update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "provider": { "type": "string", @@ -139142,12 +140546,14 @@ "providerInstallationId": { "type": "string", "description": "VCS (Version Control System) installation ID.", - "example": "5322" + "example": "5322", + "default": "" }, "organizationUrl": { "type": "string", "description": "VCS (Version Control System) organization URL. Points at the configured instance, which is not the provider's own host for a self-hosted install.", - "example": "https:\/\/github.com\/appwrite" + "example": "https:\/\/github.com\/appwrite", + "default": "" } }, "required": [ @@ -139176,12 +140582,14 @@ "id": { "type": "string", "description": "VCS (Version Control System) repository ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "VCS (Version Control System) repository name.", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "organization": { "type": "string", @@ -139191,27 +140599,32 @@ "provider": { "type": "string", "description": "VCS (Version Control System) provider name.", - "example": "github" + "example": "github", + "default": "" }, "private": { "type": "boolean", "description": "Is VCS (Version Control System) repository private?", - "example": true + "example": true, + "default": false }, "defaultBranch": { "type": "string", "description": "VCS (Version Control System) repository's default branch name.", - "example": "main" + "example": "main", + "default": "" }, "providerInstallationId": { "type": "string", "description": "VCS (Version Control System) installation ID.", - "example": "108104697" + "example": "108104697", + "default": "" }, "authorized": { "type": "boolean", "description": "Is VCS (Version Control System) repository authorized for the installation?", - "example": true + "example": true, + "default": false }, "pushedAt": { "type": "string", @@ -139227,7 +140640,8 @@ "example": [ "PORT", "NODE_ENV" - ] + ], + "default": [] } }, "required": [ @@ -139265,12 +140679,14 @@ "id": { "type": "string", "description": "VCS (Version Control System) repository ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "VCS (Version Control System) repository name.", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "organization": { "type": "string", @@ -139280,27 +140696,32 @@ "provider": { "type": "string", "description": "VCS (Version Control System) provider name.", - "example": "github" + "example": "github", + "default": "" }, "private": { "type": "boolean", "description": "Is VCS (Version Control System) repository private?", - "example": true + "example": true, + "default": false }, "defaultBranch": { "type": "string", "description": "VCS (Version Control System) repository's default branch name.", - "example": "main" + "example": "main", + "default": "" }, "providerInstallationId": { "type": "string", "description": "VCS (Version Control System) installation ID.", - "example": "108104697" + "example": "108104697", + "default": "" }, "authorized": { "type": "boolean", "description": "Is VCS (Version Control System) repository authorized for the installation?", - "example": true + "example": true, + "default": false }, "pushedAt": { "type": "string", @@ -139316,12 +140737,14 @@ "example": [ "PORT", "NODE_ENV" - ] + ], + "default": [] }, "framework": { "type": "string", "description": "Auto-detected framework. Empty if type is not \"framework\".", - "example": "nextjs" + "example": "nextjs", + "default": "" } }, "required": [ @@ -139361,12 +140784,14 @@ "id": { "type": "string", "description": "VCS (Version Control System) repository ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "VCS (Version Control System) repository name.", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "organization": { "type": "string", @@ -139376,27 +140801,32 @@ "provider": { "type": "string", "description": "VCS (Version Control System) provider name.", - "example": "github" + "example": "github", + "default": "" }, "private": { "type": "boolean", "description": "Is VCS (Version Control System) repository private?", - "example": true + "example": true, + "default": false }, "defaultBranch": { "type": "string", "description": "VCS (Version Control System) repository's default branch name.", - "example": "main" + "example": "main", + "default": "" }, "providerInstallationId": { "type": "string", "description": "VCS (Version Control System) installation ID.", - "example": "108104697" + "example": "108104697", + "default": "" }, "authorized": { "type": "boolean", "description": "Is VCS (Version Control System) repository authorized for the installation?", - "example": true + "example": true, + "default": false }, "pushedAt": { "type": "string", @@ -139412,12 +140842,14 @@ "example": [ "PORT", "NODE_ENV" - ] + ], + "default": [] }, "runtime": { "type": "string", "description": "Auto-detected runtime. Empty if type is not \"runtime\".", - "example": "node-22" + "example": "node-22", + "default": "" } }, "required": [ @@ -139466,7 +140898,8 @@ ], "title": "framework" } - ] + ], + "default": "framework" }, "variables": { "type": "array", @@ -139480,22 +140913,26 @@ "framework": { "type": "string", "description": "Framework", - "example": "nuxt" + "example": "nuxt", + "default": "" }, "installCommand": { "type": "string", "description": "Site Install Command", - "example": "npm install" + "example": "npm install", + "default": "" }, "buildCommand": { "type": "string", "description": "Site Build Command", - "example": "npm run build" + "example": "npm run build", + "default": "" }, "outputDirectory": { "type": "string", "description": "Site Output Directory", - "example": "dist" + "example": "dist", + "default": "" } }, "required": [ @@ -139530,7 +140967,8 @@ ], "title": "runtime" } - ] + ], + "default": "runtime" }, "variables": { "type": "array", @@ -139544,17 +140982,20 @@ "runtime": { "type": "string", "description": "Runtime", - "example": "node" + "example": "node", + "default": "" }, "entrypoint": { "type": "string", "description": "Function Entrypoint", - "example": "index.js" + "example": "index.js", + "default": "" }, "commands": { "type": "string", "description": "Function install and build commands", - "example": "npm install && npm run build" + "example": "npm install && npm run build", + "default": "" } }, "required": [ @@ -139578,12 +141019,14 @@ "name": { "type": "string", "description": "Name of environment variable", - "example": "NODE_ENV" + "example": "NODE_ENV", + "default": "" }, "value": { "type": "string", "description": "Value of environment variable", - "example": "production" + "example": "production", + "default": "" } }, "required": [ @@ -139604,18 +141047,21 @@ "description": "Content size in bytes. Only files have size, and for directories, 0 is returned.", "format": "int32", "example": 1523, + "default": 0, "nullable": true }, "isDirectory": { "type": "boolean", "description": "If a content is a directory. Directories can be used to check nested contents.", "example": true, + "default": false, "nullable": true }, "name": { "type": "string", "description": "Name of directory or file.", - "example": "Main.java" + "example": "Main.java", + "default": "" } }, "required": [ @@ -139634,7 +141080,8 @@ "name": { "type": "string", "description": "Branch Name.", - "example": "main" + "example": "main", + "default": "" } }, "required": [ @@ -139651,37 +141098,44 @@ "$id": { "type": "string", "description": "Runtime ID.", - "example": "python-3.8" + "example": "python-3.8", + "default": "" }, "key": { "type": "string", "description": "Parent runtime key.", - "example": "python" + "example": "python", + "default": "" }, "name": { "type": "string", "description": "Runtime Name.", - "example": "Python" + "example": "Python", + "default": "" }, "version": { "type": "string", "description": "Runtime version.", - "example": "3.8" + "example": "3.8", + "default": "" }, "base": { "type": "string", "description": "Base Docker image used to build the runtime.", - "example": "python:3.8-alpine" + "example": "python:3.8-alpine", + "default": "" }, "image": { "type": "string", "description": "Image name of Docker Hub.", - "example": "appwrite\\\/runtime-for-python:3.8" + "example": "appwrite\\\/runtime-for-python:3.8", + "default": "" }, "logo": { "type": "string", "description": "Name of the logo image.", - "example": "python.png" + "example": "python.png", + "default": "" }, "supports": { "type": "array", @@ -139722,17 +141176,20 @@ "key": { "type": "string", "description": "Framework key.", - "example": "sveltekit" + "example": "sveltekit", + "default": "" }, "name": { "type": "string", "description": "Framework Name.", - "example": "SvelteKit" + "example": "SvelteKit", + "default": "" }, "buildRuntime": { "type": "string", "description": "Default runtime version.", - "example": "node-22" + "example": "node-22", + "default": "" }, "runtimes": { "type": "array", @@ -139795,22 +141252,26 @@ "key": { "type": "string", "description": "Adapter key.", - "example": "static" + "example": "static", + "default": "" }, "installCommand": { "type": "string", "description": "Default command to download dependencies.", - "example": "npm install" + "example": "npm install", + "default": "" }, "buildCommand": { "type": "string", "description": "Default command to build site into output directory.", - "example": "npm run build" + "example": "npm run build", + "default": "" }, "outputDirectory": { "type": "string", "description": "Default output directory of build.", - "example": ".\/dist" + "example": ".\/dist", + "default": "" }, "fallbackFile": { "type": "string", @@ -139840,75 +141301,89 @@ "$id": { "type": "string", "description": "Deployment ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Deployment creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Deployment update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "type": { "type": "string", "description": "Type of deployment.", - "example": "vcs" + "example": "vcs", + "default": "" }, "resourceId": { "type": "string", "description": "Resource ID.", - "example": "5e5ea6g16897e" + "example": "5e5ea6g16897e", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type.", - "example": "functions" + "example": "functions", + "default": "" }, "entrypoint": { "type": "string", "description": "The entrypoint file to use to execute the deployment code.", - "example": "index.js" + "example": "index.js", + "default": "" }, "sourceSize": { "type": "integer", "description": "The code size in bytes.", "format": "int32", - "example": 128 + "example": 128, + "default": 0 }, "buildSize": { "type": "integer", "description": "The build output size in bytes.", "format": "int32", - "example": 128 + "example": 128, + "default": 0 }, "totalSize": { "type": "integer", "description": "The total size in bytes (source and build output).", "format": "int32", - "example": 128 + "example": 128, + "default": 0 }, "buildId": { "type": "string", "description": "The current build ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "activate": { "type": "boolean", "description": "Whether the deployment should be automatically activated.", - "example": true + "example": true, + "default": false }, "screenshotLight": { "type": "string", "description": "Screenshot with light theme preference file ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "screenshotDark": { "type": "string", "description": "Screenshot with dark theme preference file ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "status": { "description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".", @@ -139962,63 +141437,75 @@ "buildLogs": { "type": "string", "description": "The build logs.", - "example": "Compiling source files..." + "example": "Compiling source files...", + "default": "" }, "buildDuration": { "type": "integer", "description": "The current build time in seconds.", "format": "int32", - "example": 128 + "example": 128, + "default": 0 }, "providerRepositoryName": { "type": "string", "description": "The name of the vcs provider repository", - "example": "database" + "example": "database", + "default": "" }, "providerRepositoryOwner": { "type": "string", "description": "The name of the vcs provider repository owner", - "example": "utopia" + "example": "utopia", + "default": "" }, "providerRepositoryUrl": { "type": "string", "description": "The url of the vcs provider repository", - "example": "https:\/\/github.com\/vermakhushboo\/g4-node-function" + "example": "https:\/\/github.com\/vermakhushboo\/g4-node-function", + "default": "" }, "providerCommitHash": { "type": "string", "description": "The commit hash of the vcs commit", - "example": "7c3f25d" + "example": "7c3f25d", + "default": "" }, "providerCommitAuthorUrl": { "type": "string", "description": "The url of vcs commit author", - "example": "https:\/\/github.com\/vermakhushboo" + "example": "https:\/\/github.com\/vermakhushboo", + "default": "" }, "providerCommitAuthor": { "type": "string", "description": "The name of vcs commit author", - "example": "Khushboo Verma" + "example": "Khushboo Verma", + "default": "" }, "providerCommitMessage": { "type": "string", "description": "The commit message", - "example": "Update index.js" + "example": "Update index.js", + "default": "" }, "providerCommitUrl": { "type": "string", "description": "The url of the vcs commit", - "example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb" + "example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb", + "default": "" }, "providerBranch": { "type": "string", "description": "The branch of the vcs repository", - "example": "0.7.x" + "example": "0.7.x", + "default": "" }, "providerBranchUrl": { "type": "string", "description": "The branch of the vcs repository", - "example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x" + "example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x", + "default": "" } }, "required": [ @@ -140087,17 +141574,20 @@ "$id": { "type": "string", "description": "Execution ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Execution creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Execution update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -140112,7 +141602,8 @@ "resourceId": { "type": "string", "description": "Function or site ID.", - "example": "5e5ea6g16897e" + "example": "5e5ea6g16897e", + "default": "" }, "resourceType": { "description": "Execution resource type.", @@ -140133,12 +141624,14 @@ ], "title": "sites" } - ] + ], + "default": "functions" }, "deploymentId": { "type": "string", "description": "Deployment ID used to create the execution.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "trigger": { "description": "The trigger that caused the resource to execute. Possible values can be: `http`, `schedule`, or `event`.", @@ -140213,12 +141706,14 @@ "requestMethod": { "type": "string", "description": "HTTP request method type.", - "example": "GET" + "example": "GET", + "default": "" }, "requestPath": { "type": "string", "description": "HTTP request path and query.", - "example": "\/articles?id=5" + "example": "\/articles?id=5", + "default": "" }, "requestHeaders": { "type": "array", @@ -140236,12 +141731,14 @@ "type": "integer", "description": "HTTP response status code.", "format": "int32", - "example": 200 + "example": 200, + "default": 0 }, "responseBody": { "type": "string", "description": "HTTP response body. This will return empty unless execution is created as synchronous.", - "example": "" + "example": "", + "default": "" }, "responseHeaders": { "type": "array", @@ -140258,18 +141755,21 @@ "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.", - "example": "" + "example": "", + "default": "" }, "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.", - "example": "" + "example": "", + "default": "" }, "duration": { "type": "number", "description": "Total time the resource(function\/site) took to respond, in seconds.", "format": "double", - "example": 1.23 + "example": 1.23, + "default": 0 }, "scheduledAt": { "type": "string", @@ -140337,95 +141837,113 @@ "$id": { "type": "string", "description": "Project ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Project creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Project update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Project name.", - "example": "New Project" + "example": "New Project", + "default": "" }, "teamId": { "type": "string", "description": "Project team ID.", - "example": "1592981250" + "example": "1592981250", + "default": "" }, "region": { "type": "string", "description": "Project region", - "example": "fra" + "example": "fra", + "default": "fra" }, "smtpEnabled": { "type": "boolean", "description": "Status for custom SMTP", - "example": false + "example": false, + "default": false }, "smtpSenderName": { "type": "string", "description": "SMTP sender name", - "example": "John Appwrite" + "example": "John Appwrite", + "default": "" }, "smtpSenderEmail": { "type": "string", "description": "SMTP sender email", - "example": "john@appwrite.io" + "example": "john@appwrite.io", + "default": "" }, "smtpReplyToName": { "type": "string", "description": "SMTP reply to name", - "example": "Support Team" + "example": "Support Team", + "default": "" }, "smtpReplyToEmail": { "type": "string", "description": "SMTP reply to email", - "example": "support@appwrite.io" + "example": "support@appwrite.io", + "default": "" }, "smtpHost": { "type": "string", "description": "SMTP server host name", - "example": "mail.appwrite.io" + "example": "mail.appwrite.io", + "default": "" }, "smtpPort": { "type": "integer", "description": "SMTP server port", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "smtpUsername": { "type": "string", "description": "SMTP server username", - "example": "emailuser" + "example": "emailuser", + "default": "" }, "smtpPassword": { "type": "string", "description": "SMTP server password. This property is write-only and always returned empty.", "format": "password", - "example": "smtp-password" + "example": "smtp-password", + "default": "" }, "smtpSecure": { "type": "string", "description": "SMTP server secure protocol", - "example": "tls" + "example": "tls", + "default": "" }, "pingCount": { "type": "integer", "description": "Number of times the ping was received for this project.", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "pingedAt": { "type": "string", "description": "Last ping datetime in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "labels": { "type": "array", @@ -140435,18 +141953,21 @@ }, "example": [ "vip" - ] + ], + "default": [] }, "status": { "type": "string", "description": "Project status", - "example": "active" + "example": "active", + "default": "active" }, "onboarding": { "type": "object", "additionalProperties": true, "description": "Stage progress (completed or skipped) with timestamps and actor types, keyed by stage id.", - "example": {} + "example": {}, + "default": {} }, "authMethods": { "type": "array", @@ -140483,12 +142004,14 @@ "consoleAccessedAt": { "type": "string", "description": "Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "wafEnabled": { "type": "boolean", "description": "Whether WAF enforcement is enabled for the project.", "example": true, + "default": false, "nullable": true }, "billingLimits": { @@ -140517,12 +142040,14 @@ "type": "boolean", "description": "OAuth2 server status", "example": false, + "default": false, "nullable": true }, "oAuth2ServerAuthorizationUrl": { "type": "string", "description": "OAuth2 server authorization URL", "example": "https:\/\/cloud.appwrite.io\/oauth2\/.well-known\/openid-configuration", + "default": "", "nullable": true }, "oAuth2ServerScopes": { @@ -140535,6 +142060,7 @@ "read", "write" ], + "default": [], "nullable": true }, "oAuth2ServerDefaultScopes": { @@ -140546,6 +142072,7 @@ "example": [ "read" ], + "default": [], "nullable": true }, "oAuth2ServerInstallationScopes": { @@ -140557,6 +142084,7 @@ "example": [ "project:all" ], + "default": [], "nullable": true }, "oAuth2ServerAuthorizationDetailsTypes": { @@ -140568,6 +142096,7 @@ "example": [ "calendar" ], + "default": [], "nullable": true }, "oAuth2ServerAccessTokenDuration": { @@ -140575,6 +142104,7 @@ "description": "OAuth2 server access token duration in seconds for confidential clients", "format": "int32", "example": 3600, + "default": 0, "nullable": true }, "oAuth2ServerRefreshTokenDuration": { @@ -140582,6 +142112,7 @@ "description": "OAuth2 server refresh token duration in seconds for confidential clients", "format": "int32", "example": 86400, + "default": 0, "nullable": true }, "oAuth2ServerPublicAccessTokenDuration": { @@ -140589,6 +142120,7 @@ "description": "OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)", "format": "int32", "example": 3600, + "default": 0, "nullable": true }, "oAuth2ServerPublicRefreshTokenDuration": { @@ -140596,6 +142128,7 @@ "description": "OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)", "format": "int32", "example": 2592000, + "default": 0, "nullable": true }, "oAuth2ServerInstallationAccessTokenDuration": { @@ -140603,18 +142136,21 @@ "description": "OAuth2 server access token duration in seconds for app installation access tokens", "format": "int32", "example": 3600, + "default": 0, "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.", "example": false, + "default": 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.", "example": "https:\/\/cloud.appwrite.io\/device", + "default": "", "nullable": true }, "oAuth2ServerUserCodeLength": { @@ -140622,12 +142158,14 @@ "description": "Number of characters in the device flow user code, excluding the formatting separator.", "format": "int32", "example": 8, + "default": 8, "nullable": true }, "oAuth2ServerUserCodeFormat": { "type": "string", "description": "Character set for device flow user codes: `numeric`, `alphabetic`, or `alphanumeric`.", "example": "alphanumeric", + "default": "alphanumeric", "nullable": true }, "oAuth2ServerDeviceCodeDuration": { @@ -140635,12 +142173,14 @@ "description": "Lifetime in seconds of device flow device codes and user codes.", "format": "int32", "example": 600, + "default": 600, "nullable": true }, "oAuth2ServerDiscoveryUrl": { "type": "string", "description": "OAuth2 server discovery URL", "example": "https:\/\/auth.example.com\/.well-known\/openid-configuration", + "default": "", "nullable": true } }, @@ -140804,7 +142344,8 @@ "enabled": { "type": "boolean", "description": "Auth method status.", - "example": false + "example": false, + "default": true } }, "required": [ @@ -140957,7 +142498,8 @@ "enabled": { "type": "boolean", "description": "Service status.", - "example": false + "example": false, + "default": true } }, "required": [ @@ -141005,7 +142547,8 @@ "enabled": { "type": "boolean", "description": "Protocol status.", - "example": false + "example": false, + "default": true } }, "required": [ @@ -141024,27 +142567,32 @@ "$id": { "type": "string", "description": "Webhook ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Webhook creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Webhook update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Webhook name.", - "example": "My Webhook" + "example": "My Webhook", + "default": "" }, "url": { "type": "string", "description": "Webhook URL endpoint.", - "example": "https:\/\/example.com\/webhook" + "example": "https:\/\/example.com\/webhook", + "default": "" }, "events": { "type": "array", @@ -141055,44 +142603,52 @@ "example": [ "databases.tables.update", "databases.collections.update" - ] + ], + "default": [] }, "tls": { "type": "boolean", "description": "Indicates if SSL \/ TLS certificate verification is enabled.", - "example": true + "example": true, + "default": true }, "authUsername": { "type": "string", "description": "HTTP basic authentication username.", - "example": "username" + "example": "username", + "default": "" }, "authPassword": { "type": "string", "description": "HTTP basic authentication password. Write-only: always returned empty.", "format": "password", - "example": "webhook-password" + "example": "webhook-password", + "default": "" }, "secret": { "type": "string", "description": "Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.", - "example": "ad3d581ca230e2b7059c545e5a" + "example": "ad3d581ca230e2b7059c545e5a", + "default": "" }, "enabled": { "type": "boolean", "description": "Indicates if this webhook is enabled.", - "example": true + "example": true, + "default": true }, "logs": { "type": "string", "description": "Webhook error logs from the most recent failure.", - "example": "Failed to connect to remote server." + "example": "Failed to connect to remote server.", + "default": "" }, "attempts": { "type": "integer", "description": "Number of consecutive failed webhook attempts.", "format": "int32", - "example": 10 + "example": 10, + "default": 0 } }, "required": [ @@ -141136,27 +142692,32 @@ "$id": { "type": "string", "description": "Key ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Key creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Key update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Key name.", - "example": "My API Key" + "example": "My API Key", + "default": "" }, "expire": { "type": "string", "description": "Key expiration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "scopes": { "type": "array", @@ -141166,17 +142727,20 @@ }, "example": [ "users.read" - ] + ], + "default": [] }, "secret": { "type": "string", "description": "Secret key.", - "example": "919c2d18fb5d4...a2ae413da83346ad2" + "example": "919c2d18fb5d4...a2ae413da83346ad2", + "default": "" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "sdks": { "type": "array", @@ -141219,27 +142783,32 @@ "$id": { "type": "string", "description": "Key ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Key creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Key update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Key name.", - "example": "My API Key" + "example": "My API Key", + "default": "" }, "expire": { "type": "string", "description": "Key expiration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "scopes": { "type": "array", @@ -141249,17 +142818,20 @@ }, "example": [ "users.read" - ] + ], + "default": [] }, "secret": { "type": "string", "description": "Secret key.", - "example": "919c2d18fb5d4...a2ae413da83346ad2" + "example": "919c2d18fb5d4...a2ae413da83346ad2", + "default": "" }, "accessedAt": { "type": "string", "description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "sdks": { "type": "array", @@ -141302,22 +142874,26 @@ "number": { "type": "string", "description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.", - "example": "+1612842323" + "example": "+1612842323", + "default": "" }, "otp": { "type": "string", "description": "Mock OTP for the number. ", - "example": "123456" + "example": "123456", + "default": "" }, "$createdAt": { "type": "string", "description": "Attribute creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Attribute update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -141340,22 +142916,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": 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.", - "example": "e4d87900000000540733" + "example": "e4d87900000000540733", + "default": "" }, "clientSecret": { "type": "string", "description": "GitHub OAuth2 client secret.", - "example": "5e07c00000000000000000000000000000198bcc" + "example": "5e07c00000000000000000000000000000198bcc", + "default": "" }, "prompt": { "type": "array", @@ -141374,7 +142954,8 @@ }, "example": [ "select_account" - ] + ], + "default": [] } }, "required": [ @@ -141401,22 +142982,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Discord OAuth2 client ID.", - "example": "950722000000343754" + "example": "950722000000343754", + "default": "" }, "clientSecret": { "type": "string", "description": "Discord OAuth2 client secret.", - "example": "YmPXnM000000000000000000002zFg5D" + "example": "YmPXnM000000000000000000002zFg5D", + "default": "" }, "prompt": { "type": "array", @@ -141442,7 +143027,8 @@ }, "example": [ "none" - ] + ], + "default": [] } }, "required": [ @@ -141469,22 +143055,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Figma OAuth2 client ID.", - "example": "byay5H0000000000VtiI40" + "example": "byay5H0000000000VtiI40", + "default": "" }, "clientSecret": { "type": "string", "description": "Figma OAuth2 client secret.", - "example": "yEpOYn0000000000000000004iIsU5" + "example": "yEpOYn0000000000000000004iIsU5", + "default": "" } }, "required": [ @@ -141507,22 +143097,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "appKey": { "type": "string", "description": "Dropbox OAuth2 app key.", - "example": "jl000000000009t" + "example": "jl000000000009t", + "default": "" }, "appSecret": { "type": "string", "description": "Dropbox OAuth2 app secret.", - "example": "g200000000000vw" + "example": "g200000000000vw", + "default": "" } }, "required": [ @@ -141545,22 +143139,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "apiKey": { "type": "string", "description": "Dailymotion OAuth2 API key.", - "example": "07a9000000000000067f" + "example": "07a9000000000000067f", + "default": "" }, "apiSecret": { "type": "string", "description": "Dailymotion OAuth2 API secret.", - "example": "a399a90000000000000000000000000000d90639" + "example": "a399a90000000000000000000000000000d90639", + "default": "" } }, "required": [ @@ -141583,22 +143181,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "key": { "type": "string", "description": "Bitbucket OAuth2 key.", - "example": "Knt70000000000ByRc" + "example": "Knt70000000000ByRc", + "default": "" }, "secret": { "type": "string", "description": "Bitbucket OAuth2 secret.", - "example": "NMfLZJ00000000000000000000TLQdDx" + "example": "NMfLZJ00000000000000000000TLQdDx", + "default": "" } }, "required": [ @@ -141621,22 +143223,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Bitly OAuth2 client ID.", - "example": "d95151000000000000000000000000000067af9b" + "example": "d95151000000000000000000000000000067af9b", + "default": "" }, "clientSecret": { "type": "string", "description": "Bitly OAuth2 client secret.", - "example": "a13e250000000000000000000000000000d73095" + "example": "a13e250000000000000000000000000000d73095", + "default": "" } }, "required": [ @@ -141659,22 +143265,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Box OAuth2 client ID.", - "example": "deglcs00000000000000000000x2og6y" + "example": "deglcs00000000000000000000x2og6y", + "default": "" }, "clientSecret": { "type": "string", "description": "Box OAuth2 client secret.", - "example": "OKM1f100000000000000000000eshEif" + "example": "OKM1f100000000000000000000eshEif", + "default": "" } }, "required": [ @@ -141697,22 +143307,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Autodesk OAuth2 client ID.", - "example": "5zw90v00000000000000000000kVYXN7" + "example": "5zw90v00000000000000000000kVYXN7", + "default": "" }, "clientSecret": { "type": "string", "description": "Autodesk OAuth2 client secret.", - "example": "7I000000000000MW" + "example": "7I000000000000MW", + "default": "" } }, "required": [ @@ -141735,22 +143349,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Google OAuth2 client ID.", - "example": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com" + "example": "120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com", + "default": "" }, "clientSecret": { "type": "string", "description": "Google OAuth2 client secret.", - "example": "GOCSPX-2k8gsR0000000000000000VNahJj" + "example": "GOCSPX-2k8gsR0000000000000000VNahJj", + "default": "" }, "prompt": { "type": "array", @@ -141783,12 +143401,16 @@ }, "example": [ "consent" + ], + "default": [ + "consent" ] }, "nativeEnabled": { "type": "boolean", "description": "Native Google sign-in is active and can be used to create sessions from an ID token. Independent of enabled, which only controls the browser-based flow.", - "example": false + "example": false, + "default": false }, "nativeClientIds": { "type": "array", @@ -141798,7 +143420,8 @@ }, "example": [ "YOUR_ANDROID_CLIENT_ID.apps.googleusercontent.com" - ] + ], + "default": [] } }, "required": [ @@ -141831,22 +143454,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Zoom OAuth2 client ID.", - "example": "QMAC00000000000000w0AQ" + "example": "QMAC00000000000000w0AQ", + "default": "" }, "clientSecret": { "type": "string", "description": "Zoom OAuth2 client secret.", - "example": "GAWsG4000000000000000000007U01ON" + "example": "GAWsG4000000000000000000007U01ON", + "default": "" } }, "required": [ @@ -141869,22 +143496,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Zoho OAuth2 client ID.", - "example": "1000.83C178000000000000000000RPNX0B" + "example": "1000.83C178000000000000000000RPNX0B", + "default": "" }, "clientSecret": { "type": "string", "description": "Zoho OAuth2 client secret.", - "example": "fb5cac000000000000000000000000000000a68f6e" + "example": "fb5cac000000000000000000000000000000a68f6e", + "default": "" }, "prompt": { "type": "array", @@ -141903,7 +143534,8 @@ }, "example": [ "consent" - ] + ], + "default": [] } }, "required": [ @@ -141930,22 +143562,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Yandex OAuth2 client ID.", - "example": "6a8a6a0000000000000000000091483c" + "example": "6a8a6a0000000000000000000091483c", + "default": "" }, "clientSecret": { "type": "string", "description": "Yandex OAuth2 client secret.", - "example": "bbf98500000000000000000000c75a63" + "example": "bbf98500000000000000000000c75a63", + "default": "" } }, "required": [ @@ -141968,22 +143604,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "customerKey": { "type": "string", "description": "X OAuth2 customer key.", - "example": "slzZV0000000000000NFLaWT" + "example": "slzZV0000000000000NFLaWT", + "default": "" }, "secretKey": { "type": "string", "description": "X OAuth2 secret key.", - "example": "tkEPkp00000000000000000000000000000000000000FTxbI9" + "example": "tkEPkp00000000000000000000000000000000000000FTxbI9", + "default": "" } }, "required": [ @@ -142006,22 +143646,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "WordPress OAuth2 client ID.", - "example": "130005" + "example": "130005", + "default": "" }, "clientSecret": { "type": "string", "description": "WordPress OAuth2 client secret.", - "example": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk" + "example": "PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk", + "default": "" } }, "required": [ @@ -142044,22 +143688,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Webflow OAuth2 client ID.", - "example": "8bb20000000000000000000000000000000000000000000000000000000040dd" + "example": "8bb20000000000000000000000000000000000000000000000000000000040dd", + "default": "" }, "clientSecret": { "type": "string", "description": "Webflow OAuth2 client secret.", - "example": "59bf00000000000000000000000000000000000000000000000000000000fe59" + "example": "59bf00000000000000000000000000000000000000000000000000000000fe59", + "default": "" } }, "required": [ @@ -142082,22 +143730,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Twitch OAuth2 client ID.", - "example": "vvi0in000000000000000000ikmt9p" + "example": "vvi0in000000000000000000ikmt9p", + "default": "" }, "clientSecret": { "type": "string", "description": "Twitch OAuth2 client secret.", - "example": "pmapue000000000000000000zylw3v" + "example": "pmapue000000000000000000zylw3v", + "default": "" } }, "required": [ @@ -142120,22 +143772,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Stripe OAuth2 client ID.", - "example": "ca_UKibXX0000000000000000000006byvR" + "example": "ca_UKibXX0000000000000000000006byvR", + "default": "" }, "apiSecretKey": { "type": "string", "description": "Stripe OAuth2 API secret key.", - "example": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp" + "example": "sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp", + "default": "" } }, "required": [ @@ -142158,22 +143814,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Spotify OAuth2 client ID.", - "example": "6ec271000000000000000000009beace" + "example": "6ec271000000000000000000009beace", + "default": "" }, "clientSecret": { "type": "string", "description": "Spotify OAuth2 client secret.", - "example": "db068a000000000000000000008b5b9f" + "example": "db068a000000000000000000008b5b9f", + "default": "" } }, "required": [ @@ -142196,22 +143856,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Slack OAuth2 client ID.", - "example": "23000000089.15000000000023" + "example": "23000000089.15000000000023", + "default": "" }, "clientSecret": { "type": "string", "description": "Slack OAuth2 client secret.", - "example": "81656000000000000000000000f3d2fd" + "example": "81656000000000000000000000f3d2fd", + "default": "" } }, "required": [ @@ -142234,22 +143898,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Podio OAuth2 client ID.", - "example": "appwrite-oauth-test-app" + "example": "appwrite-oauth-test-app", + "default": "" }, "clientSecret": { "type": "string", "description": "Podio OAuth2 client secret.", - "example": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN" + "example": "Rn247T0000000000000000000000000000000000000000000000000000W2zWTN", + "default": "" } }, "required": [ @@ -142272,22 +143940,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "oauthClientId": { "type": "string", "description": "Notion OAuth2 client ID.", - "example": "341d8700-0000-0000-0000-000000446ee3" + "example": "341d8700-0000-0000-0000-000000446ee3", + "default": "" }, "oauthClientSecret": { "type": "string", "description": "Notion OAuth2 client secret.", - "example": "secret_dLUr4b000000000000000000000000000000lFHAa9" + "example": "secret_dLUr4b000000000000000000000000000000lFHAa9", + "default": "" } }, "required": [ @@ -142310,22 +143982,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "customerKey": { "type": "string", "description": "Salesforce OAuth2 consumer key.", - "example": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq" + "example": "3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq", + "default": "" }, "customerSecret": { "type": "string", "description": "Salesforce OAuth2 consumer secret.", - "example": "3w000000000000e2" + "example": "3w000000000000e2", + "default": "" }, "prompt": { "type": "array", @@ -142351,7 +144027,8 @@ }, "example": [ "login" - ] + ], + "default": [] } }, "required": [ @@ -142378,22 +144055,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Yahoo OAuth2 client ID.", - "example": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm" + "example": "dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm", + "default": "" }, "clientSecret": { "type": "string", "description": "Yahoo OAuth2 client secret.", - "example": "cf978f0000000000000000000000000000c5e2e9" + "example": "cf978f0000000000000000000000000000c5e2e9", + "default": "" } }, "required": [ @@ -142416,22 +144097,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Cloudflare OAuth2 client ID.", - "example": "4b866000000000000000000000c9e4e2" + "example": "4b866000000000000000000000c9e4e2", + "default": "" }, "clientSecret": { "type": "string", "description": "Cloudflare OAuth2 client secret.", - "example": "cfoc_5Q6YRl0000000000000000000000000000000000003d214f" + "example": "cfoc_5Q6YRl0000000000000000000000000000000000003d214f", + "default": "" } }, "required": [ @@ -142454,22 +144139,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Hugging Face OAuth2 client ID.", - "example": "2ab9cff9-d711-40ad-a91e-b08a49c42d24" + "example": "2ab9cff9-d711-40ad-a91e-b08a49c42d24", + "default": "" }, "clientSecret": { "type": "string", "description": "Hugging Face OAuth2 client secret.", - "example": "oauth_app_secret_wcLhRtl000000000000000000000xbNdLt" + "example": "oauth_app_secret_wcLhRtl000000000000000000000xbNdLt", + "default": "" } }, "required": [ @@ -142492,22 +144181,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "LinkedIn OAuth2 client ID.", - "example": "770000000000dv" + "example": "770000000000dv", + "default": "" }, "primaryClientSecret": { "type": "string", "description": "LinkedIn OAuth2 primary client secret.", - "example": "WPL_AP1.2Bf0000000000000.\/HtlYw==" + "example": "WPL_AP1.2Bf0000000000000.\/HtlYw==", + "default": "" } }, "required": [ @@ -142530,22 +144223,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "publicKey": { "type": "string", "description": "Disqus OAuth2 public key.", - "example": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX" + "example": "cgegH70000000000000000000000000000000000000000000000000000Hr1nYX", + "default": "" }, "secretKey": { "type": "string", "description": "Disqus OAuth2 secret key.", - "example": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9" + "example": "W7Bykj00000000000000000000000000000000000000000000000000003o43w9", + "default": "" } }, "required": [ @@ -142568,22 +144265,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Amazon OAuth2 client ID.", - "example": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2" + "example": "amzn1.application-oa2-client.87400c00000000000000000000063d5b2", + "default": "" }, "clientSecret": { "type": "string", "description": "Amazon OAuth2 client secret.", - "example": "79ffe4000000000000000000000000000000000000000000000000000002de55" + "example": "79ffe4000000000000000000000000000000000000000000000000000002de55", + "default": "" } }, "required": [ @@ -142606,22 +144307,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "keyString": { "type": "string", "description": "Etsy OAuth2 keystring.", - "example": "nsgzxh0000000000008j85a2" + "example": "nsgzxh0000000000008j85a2", + "default": "" }, "sharedSecret": { "type": "string", "description": "Etsy OAuth2 shared secret.", - "example": "tp000000ru" + "example": "tp000000ru", + "default": "" } }, "required": [ @@ -142644,22 +144349,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "appId": { "type": "string", "description": "Facebook OAuth2 app ID.", - "example": "260600000007694" + "example": "260600000007694", + "default": "" }, "appSecret": { "type": "string", "description": "Facebook OAuth2 app secret.", - "example": "2d0b2800000000000000000000d38af4" + "example": "2d0b2800000000000000000000d38af4", + "default": "" } }, "required": [ @@ -142682,22 +144391,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "oauth2ClientId": { "type": "string", "description": "Tradeshift OAuth2 client ID.", - "example": "appwrite-test-org.appwrite-test-app" + "example": "appwrite-test-org.appwrite-test-app", + "default": "" }, "oauth2ClientSecret": { "type": "string", "description": "Tradeshift OAuth2 client secret.", - "example": "7cb52700-0000-0000-0000-000000ca5b83" + "example": "7cb52700-0000-0000-0000-000000ca5b83", + "default": "" } }, "required": [ @@ -142720,22 +144433,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "PayPal OAuth2 client ID.", - "example": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB" + "example": "AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB", + "default": "" }, "secretKey": { "type": "string", "description": "PayPal OAuth2 secret key.", - "example": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp" + "example": "EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp", + "default": "" } }, "required": [ @@ -142758,27 +144475,32 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "applicationId": { "type": "string", "description": "GitLab OAuth2 application ID.", - "example": "d41ffe0000000000000000000000000000000000000000000000000000d5e252" + "example": "d41ffe0000000000000000000000000000000000000000000000000000d5e252", + "default": "" }, "secret": { "type": "string", "description": "GitLab OAuth2 secret.", - "example": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38" + "example": "gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38", + "default": "" }, "endpoint": { "type": "string", "description": "GitLab OAuth2 endpoint URL. Defaults to https:\/\/gitlab.com for self-hosted instances.", - "example": "https:\/\/gitlab.com" + "example": "https:\/\/gitlab.com", + "default": "" } }, "required": [ @@ -142803,22 +144525,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Appwrite OAuth2 client ID.", - "example": "6a42000000000000b5a0" + "example": "6a42000000000000b5a0", + "default": "" }, "clientSecret": { "type": "string", "description": "Appwrite OAuth2 client secret.", - "example": "b86afd000000000000000000000000000000000000000000000000000ced5f93" + "example": "b86afd000000000000000000000000000000000000000000000000000ced5f93", + "default": "" } }, "required": [ @@ -142841,27 +144567,32 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Authentik OAuth2 client ID.", - "example": "dTKOPa0000000000000000000000000000e7G8hv" + "example": "dTKOPa0000000000000000000000000000e7G8hv", + "default": "" }, "clientSecret": { "type": "string", "description": "Authentik OAuth2 client secret.", - "example": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK" + "example": "ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK", + "default": "" }, "endpoint": { "type": "string", "description": "Authentik OAuth2 endpoint domain.", - "example": "example.authentik.com" + "example": "example.authentik.com", + "default": "" } }, "required": [ @@ -142886,22 +144617,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Auth0 OAuth2 client ID.", - "example": "OaOkIA000000000000000000005KLSYq" + "example": "OaOkIA000000000000000000005KLSYq", + "default": "" }, "clientSecret": { "type": "string", "description": "Auth0 OAuth2 client secret.", - "example": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF" + "example": "zXz0000-00000000000000000000000000000-00000000000000000000PJafnF", + "default": "" }, "prompt": { "type": "array", @@ -142934,12 +144669,14 @@ }, "example": [ "none" - ] + ], + "default": [] }, "endpoint": { "type": "string", "description": "Auth0 OAuth2 endpoint domain.", - "example": "example.us.auth0.com" + "example": "example.us.auth0.com", + "default": "" } }, "required": [ @@ -142968,27 +144705,32 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "FusionAuth OAuth2 client ID.", - "example": "b2222c00-0000-0000-0000-000000862097" + "example": "b2222c00-0000-0000-0000-000000862097", + "default": "" }, "clientSecret": { "type": "string", "description": "FusionAuth OAuth2 client secret.", - "example": "Jx4s0C0000000000000000000000000000000wGqLsc" + "example": "Jx4s0C0000000000000000000000000000000wGqLsc", + "default": "" }, "endpoint": { "type": "string", "description": "FusionAuth OAuth2 endpoint domain.", - "example": "example.fusionauth.io" + "example": "example.fusionauth.io", + "default": "" } }, "required": [ @@ -143013,32 +144755,38 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Keycloak OAuth2 client ID.", - "example": "appwrite-o0000000st-app" + "example": "appwrite-o0000000st-app", + "default": "" }, "clientSecret": { "type": "string", "description": "Keycloak OAuth2 client secret.", - "example": "jdjrJd00000000000000000000HUsaZO" + "example": "jdjrJd00000000000000000000HUsaZO", + "default": "" }, "endpoint": { "type": "string", "description": "Keycloak OAuth2 endpoint domain.", - "example": "keycloak.example.com" + "example": "keycloak.example.com", + "default": "" }, "realmName": { "type": "string", "description": "Keycloak OAuth2 realm name.", - "example": "appwrite-realm" + "example": "appwrite-realm", + "default": "" } }, "required": [ @@ -143065,22 +144813,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "OpenID Connect OAuth2 client ID.", - "example": "qibI2x0000000000000000000000000006L2YFoG" + "example": "qibI2x0000000000000000000000000006L2YFoG", + "default": "" }, "clientSecret": { "type": "string", "description": "OpenID Connect OAuth2 client secret.", - "example": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV" + "example": "Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV", + "default": "" }, "prompt": { "type": "array", @@ -143120,27 +144872,32 @@ }, "example": [ "none" - ] + ], + "default": [] }, "wellKnownURL": { "type": "string", "description": "OpenID Connect well-known configuration URL. When set, authorization, token, and user info endpoints can be discovered automatically.", - "example": "https:\/\/myoauth.com\/.well-known\/openid-configuration" + "example": "https:\/\/myoauth.com\/.well-known\/openid-configuration", + "default": "" }, "authorizationURL": { "type": "string", "description": "OpenID Connect authorization endpoint URL.", - "example": "https:\/\/myoauth.com\/oauth2\/authorize" + "example": "https:\/\/myoauth.com\/oauth2\/authorize", + "default": "" }, "tokenURL": { "type": "string", "description": "OpenID Connect token endpoint URL.", - "example": "https:\/\/myoauth.com\/oauth2\/token" + "example": "https:\/\/myoauth.com\/oauth2\/token", + "default": "" }, "userInfoURL": { "type": "string", "description": "OpenID Connect user info endpoint URL.", - "example": "https:\/\/myoauth.com\/oauth2\/userinfo" + "example": "https:\/\/myoauth.com\/oauth2\/userinfo", + "default": "" }, "maxAge": { "type": "integer", @@ -143183,22 +144940,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Okta OAuth2 client ID.", - "example": "0oa00000000000000698" + "example": "0oa00000000000000698", + "default": "" }, "clientSecret": { "type": "string", "description": "Okta OAuth2 client secret.", - "example": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV" + "example": "Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV", + "default": "" }, "prompt": { "type": "array", @@ -143231,17 +144992,20 @@ }, "example": [ "none" - ] + ], + "default": [] }, "domain": { "type": "string", "description": "Okta OAuth2 domain.", - "example": "trial-6400025.okta.com" + "example": "trial-6400025.okta.com", + "default": "" }, "authorizationServerId": { "type": "string", "description": "Okta OAuth2 authorization server ID.", - "example": "aus000000000000000h7z" + "example": "aus000000000000000h7z", + "default": "" } }, "required": [ @@ -143272,22 +145036,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Kick OAuth2 client ID.", - "example": "01KQ7C00000000000001MFHS32" + "example": "01KQ7C00000000000001MFHS32", + "default": "" }, "clientSecret": { "type": "string", "description": "Kick OAuth2 client secret.", - "example": "34ac5600000000000000000000000000000000000000000000000000e830c8b" + "example": "34ac5600000000000000000000000000000000000000000000000000e830c8b", + "default": "" } }, "required": [ @@ -143310,37 +145078,44 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "apple" + "example": "apple", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "serviceId": { "type": "string", "description": "Apple OAuth2 service ID.", - "example": "ip.appwrite.app.web" + "example": "ip.appwrite.app.web", + "default": "" }, "keyId": { "type": "string", "description": "Apple OAuth2 key ID.", - "example": "P4000000N8" + "example": "P4000000N8", + "default": "" }, "teamId": { "type": "string", "description": "Apple OAuth2 team ID.", - "example": "D4000000R6" + "example": "D4000000R6", + "default": "" }, "p8File": { "type": "string", "description": "Apple OAuth2 .p8 private key file contents. The secret key wrapped by the PEM markers is 200 characters long.", - "example": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----" + "example": "-----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----", + "default": "" }, "nativeEnabled": { "type": "boolean", "description": "Native Sign in with Apple is active and can be used to create sessions from an ID token. Independent of enabled, which only controls the browser-based flow.", - "example": false + "example": false, + "default": false }, "nativeClientIds": { "type": "array", @@ -143350,7 +145125,8 @@ }, "example": [ "com.example.app" - ] + ], + "default": [] } }, "required": [ @@ -143383,22 +145159,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "applicationId": { "type": "string", "description": "Microsoft OAuth2 application ID.", - "example": "00001111-aaaa-2222-bbbb-3333cccc4444" + "example": "00001111-aaaa-2222-bbbb-3333cccc4444", + "default": "" }, "applicationSecret": { "type": "string", "description": "Microsoft OAuth2 application secret.", - "example": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u" + "example": "A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u", + "default": "" }, "prompt": { "type": "array", @@ -143438,12 +145218,14 @@ }, "example": [ "none" - ] + ], + "default": [] }, "tenant": { "type": "string", "description": "Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID.", - "example": "common" + "example": "common", + "default": "" } }, "required": [ @@ -143472,22 +145254,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Resend OAuth2 client ID.", - "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479" + "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "default": "" }, "clientSecret": { "type": "string", "description": "Resend OAuth2 client secret.", - "example": "9c1e4b00000000000000000000000000000000000000000000000000a72d5f4" + "example": "9c1e4b00000000000000000000000000000000000000000000000000a72d5f4", + "default": "" } }, "required": [ @@ -143510,22 +145296,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "TikTok OAuth2 client key.", - "example": "awz000000000tyw0" + "example": "awz000000000tyw0", + "default": "" }, "clientSecret": { "type": "string", "description": "TikTok OAuth2 client secret.", - "example": "6wXewM00000000000000000000yXnite" + "example": "6wXewM00000000000000000000yXnite", + "default": "" } }, "required": [ @@ -143548,22 +145338,26 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "enabled": { "type": "boolean", "description": "OAuth2 provider is active and can be used to create sessions.", - "example": false + "example": false, + "default": false }, "clientId": { "type": "string", "description": "Kakao OAuth2 REST API key.", - "example": "839ff5000000000000000000013206de" + "example": "839ff5000000000000000000013206de", + "default": "" }, "clientSecret": { "type": "string", "description": "Kakao OAuth2 client secret.", - "example": "jLNVOK00000000000000000000yJebea" + "example": "jLNVOK00000000000000000000yJebea", + "default": "" }, "prompt": { "type": "array", @@ -143603,7 +145397,8 @@ }, "example": [ "none" - ] + ], + "default": [] } }, "required": [ @@ -143631,7 +145426,8 @@ "type": "integer", "description": "Total number of OAuth2 providers in the given project.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "providers": { "type": "array", @@ -143854,12 +145650,14 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "enabled": { "type": "boolean", "description": "Whether password dictionary policy is enabled.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -143878,13 +145676,15 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "total": { "type": "integer", "description": "Password history length. A value of 0 means the policy is disabled.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 } }, "required": [ @@ -143903,33 +145703,39 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "min": { "type": "integer", "description": "Minimum password length required for user passwords.", "format": "int32", - "example": 12 + "example": 12, + "default": 8 }, "uppercase": { "type": "boolean", "description": "Whether passwords must include at least one uppercase letter.", - "example": true + "example": true, + "default": false }, "lowercase": { "type": "boolean", "description": "Whether passwords must include at least one lowercase letter.", - "example": true + "example": true, + "default": false }, "number": { "type": "boolean", "description": "Whether passwords must include at least one number.", - "example": true + "example": true, + "default": false }, "symbols": { "type": "boolean", "description": "Whether passwords must include at least one symbol.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -143956,12 +145762,14 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "enabled": { "type": "boolean", "description": "Whether password personal data policy is enabled.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -143980,22 +145788,26 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "enabled": { "type": "boolean", "description": "Whether passwords are checked against known data breaches and the result recorded on the user.", - "example": true + "example": true, + "default": true }, "sessions": { "type": "boolean", "description": "Whether a sign-in with a breached password is refused until the password is reset.", - "example": false + "example": false, + "default": false }, "users": { "type": "boolean", "description": "Whether a breached password is rejected when a user signs up or sets a new password.", - "example": false + "example": false, + "default": false } }, "required": [ @@ -144011,6 +145823,41 @@ "users": false } }, + "policyPasswordRotation": { + "description": "Policy Password Rotation", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Policy ID.", + "example": "password-dictionary", + "default": "" + }, + "enabled": { + "type": "boolean", + "description": "Whether expired passwords require a reset before email\/password sign-in.", + "example": true, + "default": false + }, + "maxAge": { + "type": "integer", + "description": "Maximum password age in seconds.", + "format": "int32", + "example": 31536000, + "default": 31536000 + } + }, + "required": [ + "$id", + "enabled", + "maxAge" + ], + "example": { + "$id": "password-dictionary", + "enabled": true, + "maxAge": 31536000 + } + }, "policySessionAlert": { "description": "Policy Session Alert", "type": "object", @@ -144018,12 +145865,14 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "enabled": { "type": "boolean", "description": "Whether session alert policy is enabled.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -144042,13 +145891,15 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "duration": { "type": "integer", "description": "Session duration in seconds.", "format": "int32", - "example": 3600 + "example": 3600, + "default": 31536000 } }, "required": [ @@ -144067,12 +145918,14 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "enabled": { "type": "boolean", "description": "Whether session invalidation policy is enabled.", - "example": true + "example": true, + "default": true } }, "required": [ @@ -144091,13 +145944,15 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "total": { "type": "integer", "description": "Maximum number of sessions allowed per user. A value of 0 means the policy is disabled.", "format": "int32", - "example": 10 + "example": 10, + "default": 0 } }, "required": [ @@ -144116,13 +145971,15 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "total": { "type": "integer", "description": "Maximum number of users allowed in the project. A value of 0 means the policy is disabled.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 } }, "required": [ @@ -144141,37 +145998,44 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "userId": { "type": "boolean", "description": "Whether user ID is visible in memberships.", - "example": true + "example": true, + "default": false }, "userEmail": { "type": "boolean", "description": "Whether user email is visible in memberships.", - "example": true + "example": true, + "default": false }, "userPhone": { "type": "boolean", "description": "Whether user phone is visible in memberships.", - "example": true + "example": true, + "default": false }, "userName": { "type": "boolean", "description": "Whether user name is visible in memberships.", - "example": true + "example": true, + "default": false }, "userMFA": { "type": "boolean", "description": "Whether user MFA status is visible in memberships.", - "example": true + "example": true, + "default": false }, "userAccessedAt": { "type": "boolean", "description": "Whether user last access time is visible in memberships.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -144200,27 +146064,32 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "totp": { "type": "boolean", "description": "Whether TOTP can be used to complete an MFA challenge.", - "example": true + "example": true, + "default": true }, "email": { "type": "boolean", "description": "Whether email can be used to complete an MFA challenge.", - "example": true + "example": true, + "default": true }, "phone": { "type": "boolean", "description": "Whether phone (SMS) can be used to complete an MFA challenge.", - "example": true + "example": true, + "default": true }, "custom": { "type": "boolean", "description": "Whether the custom factor can be used to complete an MFA challenge.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -144245,22 +146114,26 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "rpId": { "type": "string", "description": "Relying party ID passkeys are bound to. Empty until configured.", - "example": "example.com" + "example": "example.com", + "default": "" }, "origins": { "type": "array", - "description": "Web origins allowed to register and sign in with passkeys.", + "description": "Web origins passkeys work on, from the project's platforms on the relying party ID and a localhost web platform. Read-only.", "items": { "type": "string" }, "example": [ - "https:\/\/example.com" - ] + "https:\/\/app.example.com", + "http:\/\/localhost" + ], + "default": [] } }, "required": [ @@ -144272,7 +146145,8 @@ "$id": "password-dictionary", "rpId": "example.com", "origins": [ - "https:\/\/example.com" + "https:\/\/app.example.com", + "http:\/\/localhost" ] } }, @@ -144283,12 +146157,14 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "enabled": { "type": "boolean", "description": "Whether the deny aliased email policy is enabled.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -144307,12 +146183,14 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "enabled": { "type": "boolean", "description": "Whether the deny disposable email policy is enabled.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -144331,12 +146209,14 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "enabled": { "type": "boolean", "description": "Whether the deny free email policy is enabled.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -144355,12 +146235,14 @@ "$id": { "type": "string", "description": "Policy ID.", - "example": "password-dictionary" + "example": "password-dictionary", + "default": "" }, "enabled": { "type": "boolean", "description": "Whether the deny non-corporate email policy is enabled.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -144379,22 +146261,26 @@ "$id": { "type": "string", "description": "Platform ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Platform name.", - "example": "My Web App" + "example": "My Web App", + "default": "" }, "type": { "description": "Platform type. Possible values are: windows, apple, android, linux, web.", @@ -144442,7 +146328,8 @@ "hostname": { "type": "string", "description": "Web app hostname. Empty string for other platforms.", - "example": "app.example.com" + "example": "app.example.com", + "default": "" } }, "required": [ @@ -144451,8 +146338,7 @@ "$updatedAt", "name", "type", - "hostname", - "key" + "hostname" ], "example": { "$id": "5e5ea5c16897e", @@ -144470,22 +146356,26 @@ "$id": { "type": "string", "description": "Platform ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Platform name.", - "example": "My Web App" + "example": "My Web App", + "default": "" }, "type": { "description": "Platform type. Possible values are: windows, apple, android, linux, web.", @@ -144533,7 +146423,8 @@ "bundleIdentifier": { "type": "string", "description": "Apple bundle identifier.", - "example": "com.company.appname" + "example": "com.company.appname", + "default": "" } }, "required": [ @@ -144560,22 +146451,26 @@ "$id": { "type": "string", "description": "Platform ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Platform name.", - "example": "My Web App" + "example": "My Web App", + "default": "" }, "type": { "description": "Platform type. Possible values are: windows, apple, android, linux, web.", @@ -144623,7 +146518,19 @@ "applicationId": { "type": "string", "description": "Android application ID.", - "example": "com.company.appname" + "example": "com.company.appname", + "default": "" + }, + "fingerprints": { + "type": "array", + "description": "SHA-256 fingerprints of the certificates the app is signed with. Passkeys created in the app are accepted when its signature matches one.", + "items": { + "type": "string" + }, + "example": [ + "14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5" + ], + "default": [] } }, "required": [ @@ -144632,7 +146539,8 @@ "$updatedAt", "name", "type", - "applicationId" + "applicationId", + "fingerprints" ], "example": { "$id": "5e5ea5c16897e", @@ -144640,7 +146548,8 @@ "$updatedAt": "2020-10-15T06:38:00.000+00:00", "name": "My Web App", "type": "web", - "applicationId": "com.company.appname" + "applicationId": "com.company.appname", + "fingerprints": "14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5" } }, "platformWindows": { @@ -144650,22 +146559,26 @@ "$id": { "type": "string", "description": "Platform ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Platform name.", - "example": "My Web App" + "example": "My Web App", + "default": "" }, "type": { "description": "Platform type. Possible values are: windows, apple, android, linux, web.", @@ -144713,7 +146626,8 @@ "packageIdentifierName": { "type": "string", "description": "Windows package identifier name.", - "example": "com.company.appname" + "example": "com.company.appname", + "default": "" } }, "required": [ @@ -144740,22 +146654,26 @@ "$id": { "type": "string", "description": "Platform ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Platform creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Platform update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Platform name.", - "example": "My Web App" + "example": "My Web App", + "default": "" }, "type": { "description": "Platform type. Possible values are: windows, apple, android, linux, web.", @@ -144803,7 +146721,8 @@ "packageName": { "type": "string", "description": "Linux package name.", - "example": "com.company.appname" + "example": "com.company.appname", + "default": "" } }, "required": [ @@ -144831,7 +146750,8 @@ "type": "integer", "description": "Total number of platforms in the given project.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "platforms": { "type": "array", @@ -144884,42 +146804,50 @@ "$id": { "type": "string", "description": "Variable ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Variable creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Variable creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "key": { "type": "string", "description": "Variable key.", - "example": "API_KEY" + "example": "API_KEY", + "default": "" }, "value": { "type": "string", "description": "Variable value.", - "example": "myPa$$word1" + "example": "myPa$$word1", + "default": "" }, "secret": { "type": "boolean", "description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.", - "example": false + "example": false, + "default": false }, "resourceType": { "type": "string", "description": "Service to which the variable belongs. Possible values are \"project\", \"function\"", - "example": "function" + "example": "function", + "default": "" }, "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.", - "example": "myAwesomeFunction" + "example": "myAwesomeFunction", + "default": "" } }, "required": [ @@ -144950,12 +146878,14 @@ "name": { "type": "string", "description": "Country name.", - "example": "United States" + "example": "United States", + "default": "" }, "code": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "example": "US" + "example": "US", + "default": "" } }, "required": [ @@ -144974,12 +146904,14 @@ "name": { "type": "string", "description": "Continent name.", - "example": "Europe" + "example": "Europe", + "default": "" }, "code": { "type": "string", "description": "Continent two letter code.", - "example": "EU" + "example": "EU", + "default": "" } }, "required": [ @@ -144998,17 +146930,20 @@ "name": { "type": "string", "description": "Language name.", - "example": "Italian" + "example": "Italian", + "default": "" }, "code": { "type": "string", "description": "Language two-character ISO 639-1 codes.", - "example": "it" + "example": "it", + "default": "" }, "nativeName": { "type": "string", "description": "Language native name.", - "example": "Italiano" + "example": "Italiano", + "default": "" } }, "required": [ @@ -145029,39 +146964,46 @@ "symbol": { "type": "string", "description": "Currency symbol.", - "example": "$" + "example": "$", + "default": "" }, "name": { "type": "string", "description": "Currency name.", - "example": "US dollar" + "example": "US dollar", + "default": "" }, "symbolNative": { "type": "string", "description": "Currency native symbol.", - "example": "$" + "example": "$", + "default": "" }, "decimalDigits": { "type": "integer", "description": "Number of decimal digits.", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "rounding": { "type": "number", "description": "Currency digit rounding.", "format": "double", - "example": 0 + "example": 0, + "default": 0 }, "code": { "type": "string", "description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.", - "example": "USD" + "example": "USD", + "default": "" }, "namePlural": { "type": "string", "description": "Currency plural name", - "example": "US dollars" + "example": "US dollars", + "default": "" } }, "required": [ @@ -145090,17 +147032,20 @@ "code": { "type": "string", "description": "Phone code.", - "example": "+1" + "example": "+1", + "default": "" }, "countryCode": { "type": "string", "description": "Country two-character ISO 3166-1 alpha code.", - "example": "US" + "example": "US", + "default": "" }, "countryName": { "type": "string", "description": "Country name.", - "example": "United States" + "example": "United States", + "default": "" } }, "required": [ @@ -145122,12 +147067,14 @@ "type": "integer", "description": "The value of this metric at the timestamp.", "format": "int32", - "example": 1 + "example": 1, + "default": -1 }, "date": { "type": "string", "description": "The date at which this metric was aggregated in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -145146,19 +147093,22 @@ "range": { "type": "string", "description": "Time range of the usage stats.", - "example": "30d" + "example": "30d", + "default": "" }, "usersTotal": { "type": "integer", "description": "Total aggregated number of statistics of users.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "sessionsTotal": { "type": "integer", "description": "Total aggregated number of active sessions.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "users": { "type": "array", @@ -145199,13 +147149,15 @@ "range": { "type": "string", "description": "Time range of the usage stats.", - "example": "30d" + "example": "30d", + "default": "" }, "usersOnlineTotal": { "type": "integer", "description": "Current total number of online users.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "presences": { "type": "array", @@ -145241,7 +147193,8 @@ "type": "number", "description": "Aggregated value for the point.", "format": "double", - "example": 5000 + "example": 5000, + "default": 0 }, "path": { "type": "string", @@ -145511,7 +147464,8 @@ "metric": { "type": "string", "description": "Metric key this series describes.", - "example": "files.storage" + "example": "files.storage", + "default": "" }, "points": { "type": "array", @@ -145538,7 +147492,8 @@ "interval": { "type": "string", "description": "Requested interval, or an empty string for a flat aggregate.", - "example": "1h" + "example": "1h", + "default": "" }, "metrics": { "type": "array", @@ -145565,7 +147520,8 @@ "interval": { "type": "string", "description": "Requested interval, or an empty string for a flat aggregate.", - "example": "1h" + "example": "1h", + "default": "" }, "metrics": { "type": "array", @@ -145592,12 +147548,14 @@ "name": { "type": "string", "description": "Header name.", - "example": "Content-Type" + "example": "Content-Type", + "default": "" }, "value": { "type": "string", "description": "Header value.", - "example": "application\/json" + "example": "application\/json", + "default": "" } }, "required": [ @@ -145617,23 +147575,27 @@ "type": "integer", "description": "Memory size in MB.", "format": "int32", - "example": 512 + "example": 512, + "default": 0 }, "cpus": { "type": "number", "description": "Number of CPUs.", "format": "double", - "example": 1 + "example": 1, + "default": 0 }, "enabled": { "type": "boolean", "description": "Is size enabled.", - "example": true + "example": true, + "default": false }, "slug": { "type": "string", "description": "Size slug.", - "example": "s-1vcpu-512mb" + "example": "s-1vcpu-512mb", + "default": "" } }, "required": [ @@ -145656,48 +147618,57 @@ "$id": { "type": "string", "description": "Rule ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Rule creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Rule update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "domain": { "type": "string", "description": "Domain name.", - "example": "appwrite.company.com" + "example": "appwrite.company.com", + "default": "" }, "type": { "type": "string", "description": "Action definition for the rule. Possible values are \"api\", \"deployment\", or \"redirect\"", - "example": "deployment" + "example": "deployment", + "default": "" }, "trigger": { "type": "string", "description": "Defines how the rule was created. Possible values are \"manual\" or \"deployment\"", - "example": "manual" + "example": "manual", + "default": "" }, "redirectUrl": { "type": "string", "description": "URL to redirect to. Used if type is \"redirect\"", - "example": "https:\/\/appwrite.io\/docs" + "example": "https:\/\/appwrite.io\/docs", + "default": "" }, "redirectStatusCode": { "type": "integer", "description": "Status code to apply during redirect. Used if type is \"redirect\"", "format": "int32", - "example": 301 + "example": 301, + "default": 301 }, "deploymentId": { "type": "string", "description": "ID of deployment. Used if type is \"deployment\"", - "example": "n3u9feiwmf" + "example": "n3u9feiwmf", + "default": "" }, "deploymentResourceType": { "description": "Type of deployment resource: function, site, or dedicatedDatabase.", @@ -145731,12 +147702,14 @@ "deploymentResourceId": { "type": "string", "description": "ID of deployment's resource (site or function ID). Used if type is \"deployment\"", - "example": "n3u9feiwmf" + "example": "n3u9feiwmf", + "default": "" }, "deploymentVcsProviderBranch": { "type": "string", "description": "Name of Git branch that updates rule. Used if type is \"deployment\"", - "example": "main" + "example": "main", + "default": "" }, "status": { "description": "Domain verification status. Possible values are \"unverified\", \"verifying\", \"verified\"", @@ -145764,12 +147737,14 @@ ], "title": "verified" } - ] + ], + "default": "unverified" }, "logs": { "type": "string", "description": "Logs from rule verification or certificate generation. Certificate generation logs are prioritized if both are available.", - "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.", + "default": "" }, "renewAt": { "type": "string", @@ -145818,58 +147793,77 @@ "$id": { "type": "string", "description": "Schedule ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Schedule creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Schedule update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "resourceType": { "type": "string", "description": "The resource type associated with this schedule.", - "example": "function" + "example": "function", + "default": "" }, "resourceId": { "type": "string", "description": "The resource ID associated with this schedule.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "resourceUpdatedAt": { "type": "string", "description": "Change-tracking timestamp used by the scheduler to detect resource changes in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "projectId": { "type": "string", "description": "The project ID associated with this schedule.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "schedule": { "type": "string", "description": "The CRON schedule expression.", - "example": "5 4 * * *" + "example": "5 4 * * *", + "default": "" + }, + "interval": { + "type": "integer", + "description": "Minutes between runs. 0 when the schedule has no interval.", + "format": "int32", + "example": 60, + "default": 0, + "nullable": true }, "data": { "type": "object", "additionalProperties": true, "description": "Schedule data used to store resource-specific context needed for execution.", - "example": {} + "example": {}, + "default": {} }, "active": { "type": "boolean", "description": "Whether the schedule is active.", - "example": true + "example": true, + "default": false }, "region": { "type": "string", "description": "The region where the schedule is deployed.", - "example": "fra" + "example": "fra", + "default": "" } }, "required": [ @@ -145894,6 +147888,7 @@ "resourceUpdatedAt": "2020-10-15T06:38:00.000+00:00", "projectId": "5e5ea5c16897e", "schedule": "5 4 * * *", + "interval": 60, "data": {}, "active": true, "region": "fra" @@ -145906,27 +147901,32 @@ "id": { "type": "string", "description": "Stage ID.", - "example": "tablesDB.create" + "example": "tablesDB.create", + "default": "" }, "sdk": { "type": "string", "description": "SDK method key (namespace.name) for this stage.", - "example": "tablesDB.create" + "example": "tablesDB.create", + "default": "" }, "status": { "type": "string", "description": "Stage status.", - "example": "completed" + "example": "completed", + "default": "pending" }, "at": { "type": "string", "description": "When the stage was completed or skipped, in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "actorType": { "type": "string", "description": "Actor type when the stage was recorded.", - "example": "user" + "example": "user", + "default": "" } }, "required": [ @@ -145951,42 +147951,50 @@ "templateId": { "type": "string", "description": "Template type", - "example": "verification" + "example": "verification", + "default": "" }, "locale": { "type": "string", "description": "Template locale", - "example": "en_us" + "example": "en_us", + "default": "" }, "message": { "type": "string", "description": "Template message", - "example": "Click on the link to verify your account." + "example": "Click on the link to verify your account.", + "default": "" }, "senderName": { "type": "string", "description": "Name of the sender", - "example": "My User" + "example": "My User", + "default": "" }, "senderEmail": { "type": "string", "description": "Email of the sender", - "example": "mail@appwrite.io" + "example": "mail@appwrite.io", + "default": "" }, "replyToEmail": { "type": "string", "description": "Reply to email address", - "example": "emails@appwrite.io" + "example": "emails@appwrite.io", + "default": "" }, "replyToName": { "type": "string", "description": "Reply to name", - "example": "Support Team" + "example": "Support Team", + "default": "" }, "subject": { "type": "string", "description": "Email subject", - "example": "Please verify your email address" + "example": "Please verify your email address", + "default": "" } }, "required": [ @@ -146017,12 +148025,14 @@ "_APP_DOMAIN_TARGET_CNAME": { "type": "string", "description": "CNAME target for your Appwrite custom domains.", - "example": "appwrite.io" + "example": "appwrite.io", + "default": "" }, "_APP_DOMAIN_TARGET_A": { "type": "string", "description": "A target for your Appwrite custom domains.", - "example": "127.0.0.1" + "example": "127.0.0.1", + "default": "" }, "_APP_COMPUTE_BUILD_TIMEOUT": { "type": "integer", @@ -146033,12 +148043,14 @@ "_APP_DOMAIN_TARGET_AAAA": { "type": "string", "description": "AAAA target for your Appwrite custom domains.", - "example": "::1" + "example": "::1", + "default": "" }, "_APP_DOMAIN_TARGET_CAA": { "type": "string", "description": "CAA target for your Appwrite custom domains.", - "example": "digicert.com" + "example": "digicert.com", + "default": "" }, "_APP_STORAGE_LIMIT": { "type": "integer", @@ -146055,12 +148067,14 @@ "_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'.", - "example": "enabled" + "example": "enabled", + "default": "" }, "_APP_VCS_ENABLED": { "type": "boolean", "description": "Defines if VCS (Version Control System) is enabled.", - "example": true + "example": true, + "default": false }, "_APP_VCS_PROVIDERS": { "type": "array", @@ -146070,7 +148084,8 @@ }, "example": [ "github" - ] + ], + "default": [] }, "_APP_VCS_PROVIDERS_WITH_REPOSITORY_CREATION": { "type": "array", @@ -146080,7 +148095,8 @@ }, "example": [ "github" - ] + ], + "default": [] }, "_APP_VCS_PROVIDERS_WITH_PUBLIC_REPOSITORIES": { "type": "array", @@ -146090,93 +148106,111 @@ }, "example": [ "github" - ] + ], + "default": [] }, "_APP_DOMAIN_ENABLED": { "type": "boolean", "description": "Defines if main domain is configured. If so, custom domains can be created.", - "example": true + "example": true, + "default": false }, "_APP_DOMAIN_SITES": { "type": "string", "description": "A comma separated list of domains to use for site URLs.", - "example": "sites.localhost,sites.example.com" + "example": "sites.localhost,sites.example.com", + "default": "" }, "_APP_DOMAIN_FUNCTIONS": { "type": "string", "description": "A domain to use for function URLs.", - "example": "functions.localhost" + "example": "functions.localhost", + "default": "" }, "_APP_OPTIONS_FORCE_HTTPS": { "type": "string", "description": "Defines if HTTPS is enforced for all requests.", - "example": "enabled" + "example": "enabled", + "default": "" }, "_APP_DOMAINS_NAMESERVERS": { "type": "string", "description": "Comma-separated list of nameservers.", - "example": "ns1.example.com,ns2.example.com" + "example": "ns1.example.com,ns2.example.com", + "default": "" }, "_APP_DB_ADAPTER": { "type": "string", "description": "Database adapter in use.", - "example": "mysql" + "example": "mysql", + "default": "mariadb" }, "supportForRelationships": { "type": "boolean", "description": "Whether the database adapter supports relationships.", - "example": true + "example": true, + "default": true }, "supportForOperators": { "type": "boolean", "description": "Whether the database adapter supports operators.", - "example": true + "example": true, + "default": true }, "supportForSpatials": { "type": "boolean", "description": "Whether the database adapter supports spatial attributes.", - "example": true + "example": true, + "default": true }, "supportForSpatialIndexNull": { "type": "boolean", "description": "Whether the database adapter supports spatial indexes on nullable columns.", - "example": false + "example": false, + "default": false }, "supportForFulltextWildcard": { "type": "boolean", "description": "Whether the database adapter supports fulltext wildcard search.", - "example": true + "example": true, + "default": true }, "supportForMultipleFulltextIndexes": { "type": "boolean", "description": "Whether the database adapter supports multiple fulltext indexes per collection.", - "example": true + "example": true, + "default": true }, "supportForAttributeResizing": { "type": "boolean", "description": "Whether the database adapter supports resizing attributes.", - "example": true + "example": true, + "default": true }, "supportForSchemas": { "type": "boolean", "description": "Whether the database adapter supports fixed schemas with row width limits.", - "example": true + "example": true, + "default": true }, "maxIndexLength": { "type": "integer", "description": "Maximum index length supported by the database adapter.", "format": "int32", - "example": 768 + "example": 768, + "default": 768 }, "supportForIntegerIds": { "type": "boolean", "description": "Whether the database adapter uses integer sequence IDs.", - "example": true + "example": true, + "default": true }, "_APP_CONSOLE_EMAIL_VERIFICATION": { "type": "string", "description": "Whether email verification for console users is required. Can be \"true\" or \"false\".", - "example": "true" + "example": "true", + "default": "" } }, "required": [ @@ -146255,22 +148289,26 @@ "$id": { "type": "string", "description": "Parameter ID. Maps to the request body field used by the project OAuth2 update endpoint (e.g. `clientId`, `appKey`, `tenant`).", - "example": "clientId" + "example": "clientId", + "default": "" }, "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.", - "example": "Client ID or App ID" + "example": "Client ID or App ID", + "default": "" }, "example": { "type": "string", "description": "Example value for this parameter.", - "example": "e4d87900000000540733" + "example": "e4d87900000000540733", + "default": "" }, "hint": { "type": "string", "description": "Optional hint for this parameter, typically calling out a common wrong value. Empty string when no hint is set.", - "example": "Example of wrong value: 370006" + "example": "Example of wrong value: 370006", + "default": "" } }, "required": [ @@ -146293,7 +148331,8 @@ "$id": { "type": "string", "description": "OAuth2 provider ID.", - "example": "github" + "example": "github", + "default": "" }, "parameters": { "type": "array", @@ -146321,7 +148360,8 @@ "type": "integer", "description": "Total number of OAuth2 providers exposed by the server.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "oAuth2Providers": { "type": "array", @@ -146348,22 +148388,26 @@ "$id": { "type": "string", "description": "Scope ID.", - "example": "users.read" + "example": "users.read", + "default": "" }, "description": { "type": "string", "description": "Scope description.", - "example": "Access to read your project's users" + "example": "Access to read your project's users", + "default": "" }, "category": { "type": "string", "description": "Scope category.", - "example": "Auth" + "example": "Auth", + "default": "" }, "deprecated": { "type": "boolean", "description": "Scope is deprecated.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -146387,7 +148431,8 @@ "type": "integer", "description": "Total number of key scopes exposed by the server.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "scopes": { "type": "array", @@ -146414,22 +148459,26 @@ "$id": { "type": "string", "description": "Token ID.", - "example": "bb8ea5c16897e" + "example": "bb8ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "User ID.", - "example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8", + "default": "" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -146452,27 +148501,32 @@ "$id": { "type": "string", "description": "Token ID.", - "example": "bb8ea5c16897e" + "example": "bb8ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "User ID.", - "example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8", + "default": "" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "code": { "type": "string", "description": "Challenge code to be delivered to the end user through a custom channel.", - "example": "446372" + "example": "446372", + "default": "" } }, "required": [ @@ -146497,32 +148551,38 @@ "$id": { "type": "string", "description": "Token ID.", - "example": "bb8ea5c16897e" + "example": "bb8ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Token creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "User ID.", - "example": "5e5ea5c168bb8" + "example": "5e5ea5c168bb8", + "default": "" }, "secret": { "type": "string", "description": "Token secret key. Exchange it for a session with the create session endpoint.", - "example": "" + "example": "", + "default": "" }, "expire": { "type": "string", "description": "Token expiration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "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.", - "example": "Golden Fox" + "example": "Golden Fox", + "default": "" } }, "required": [ @@ -146549,27 +148609,32 @@ "$id": { "type": "string", "description": "Passkey ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Passkey creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Passkey update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Passkey name.", - "example": "My laptop" + "example": "My laptop", + "default": "" }, "accessedAt": { "type": "string", "description": "Most recent sign-in with this passkey in ISO 8601 format. Empty until the passkey is used to sign in.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -146594,22 +148659,26 @@ "$id": { "type": "string", "description": "Challenge ID. When signing in, pass it back with the credential to receive a token.", - "example": "bb8ea5c16897e" + "example": "bb8ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Challenge creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "passkeyId": { "type": "string", "description": "ID of the passkey being registered. Empty for sign-in challenges.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "expire": { "type": "string", "description": "Challenge expiration date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "publicKey": { "type": "object", @@ -146619,7 +148688,8 @@ "challenge": "PBN-3LnR1ZxSSpC0TgJsbUu92mcdgErmvtne916-yPs", "rpId": "example.com", "userVerification": "required" - } + }, + "default": {} } }, "required": [ @@ -146649,7 +148719,8 @@ "type": "integer", "description": "Total number of passkeys that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "passkeys": { "type": "array", @@ -146682,7 +148753,8 @@ "example": [ "a3kf0-s0cl2", "s0co1-as98s" - ] + ], + "default": [] } }, "required": [ @@ -146702,12 +148774,14 @@ "secret": { "type": "string", "description": "Secret token used for TOTP factor.", - "example": "[SHARED_SECRET]" + "example": "[SHARED_SECRET]", + "default": "" }, "uri": { "type": "string", "description": "URI for authenticator apps.", - "example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite" + "example": "otpauth:\/\/totp\/appwrite:user@example.com?secret=[SHARED_SECRET]&issuer=appwrite", + "default": "" } }, "required": [ @@ -146726,27 +148800,32 @@ "totp": { "type": "boolean", "description": "Can TOTP be used for MFA challenge for this account.", - "example": true + "example": true, + "default": false }, "phone": { "type": "boolean", "description": "Can phone (SMS) be used for MFA challenge for this account.", - "example": true + "example": true, + "default": false }, "email": { "type": "boolean", "description": "Can email be used for MFA challenge for this account.", - "example": true + "example": true, + "default": false }, "recoveryCode": { "type": "boolean", "description": "Can recovery code be used for MFA challenge for this account.", - "example": true + "example": true, + "default": false }, "custom": { "type": "boolean", "description": "Can custom factor be used for MFA challenge for this account.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -146771,37 +148850,44 @@ "$id": { "type": "string", "description": "Provider ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Provider creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Provider update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "The name for the provider instance.", - "example": "Mailgun" + "example": "Mailgun", + "default": "" }, "provider": { "type": "string", "description": "The name of the provider service.", - "example": "mailgun" + "example": "mailgun", + "default": "" }, "enabled": { "type": "boolean", "description": "Is provider enabled?", - "example": true + "example": true, + "default": true }, "type": { "type": "string", "description": "Type of provider.", - "example": "sms" + "example": "sms", + "default": "" }, "credentials": { "type": "object", @@ -146809,7 +148895,8 @@ "description": "Provider credentials.", "example": { "key": "123456789" - } + }, + "default": {} }, "options": { "type": "object", @@ -146817,7 +148904,8 @@ "description": "Provider options.", "example": { "from": "sender-email@mydomain" - } + }, + "default": {} } }, "required": [ @@ -146853,22 +148941,26 @@ "$id": { "type": "string", "description": "Message ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Message creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Message update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "providerType": { "type": "string", "description": "Message provider type.", - "example": "email" + "example": "email", + "default": "" }, "topics": { "type": "array", @@ -146910,6 +149002,7 @@ "type": "string", "description": "The time when the message was delivered.", "example": "2020-10-15T06:38:00.000+00:00", + "default": "", "nullable": true }, "deliveryErrors": { @@ -146927,7 +149020,8 @@ "type": "integer", "description": "Number of recipients the message was delivered to.", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "data": { "type": "object", @@ -146936,7 +149030,8 @@ "example": { "subject": "Welcome to Appwrite", "content": "Hi there, welcome to Appwrite family." - } + }, + "default": {} }, "status": { "description": "Status of delivery.", @@ -146978,7 +149073,8 @@ ], "title": "failed" } - ] + ], + "default": "draft" } }, "required": [ @@ -147027,40 +149123,47 @@ "$id": { "type": "string", "description": "Topic ID.", - "example": "259125845563242502" + "example": "259125845563242502", + "default": "" }, "$createdAt": { "type": "string", "description": "Topic creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Topic update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "The name of the topic.", - "example": "events" + "example": "events", + "default": "" }, "emailTotal": { "type": "integer", "description": "Total count of email subscribers subscribed to the topic.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "smsTotal": { "type": "integer", "description": "Total count of SMS subscribers subscribed to the topic.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "pushTotal": { "type": "integer", "description": "Total count of push subscribers subscribed to the topic.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "subscribe": { "type": "array", @@ -147070,6 +149173,9 @@ }, "example": [ "users" + ], + "default": [ + "users" ] }, "qos": { @@ -147117,33 +149223,39 @@ "$id": { "type": "string", "description": "Transaction ID.", - "example": "259125845563242502" + "example": "259125845563242502", + "default": "" }, "$createdAt": { "type": "string", "description": "Transaction creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Transaction update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "status": { "type": "string", "description": "Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.", - "example": "pending" + "example": "pending", + "default": "pending" }, "operations": { "type": "integer", "description": "Number of operations in the transaction.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "expiresAt": { "type": "string", "description": "Expiration time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -147170,22 +149282,26 @@ "$id": { "type": "string", "description": "Subscriber ID.", - "example": "259125845563242502" + "example": "259125845563242502", + "default": "" }, "$createdAt": { "type": "string", "description": "Subscriber creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Subscriber update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "targetId": { "type": "string", "description": "Target ID.", - "example": "259125845563242502" + "example": "259125845563242502", + "default": "" }, "target": { "type": "object", @@ -147209,22 +149325,26 @@ "userId": { "type": "string", "description": "Topic ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "userName": { "type": "string", "description": "User Name.", - "example": "Aegon Targaryen" + "example": "Aegon Targaryen", + "default": "" }, "topicId": { "type": "string", "description": "Topic ID.", - "example": "259125845563242502" + "example": "259125845563242502", + "default": "" }, "providerType": { "type": "string", "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "example": "email" + "example": "email", + "default": "" } }, "required": [ @@ -147266,48 +149386,57 @@ "$id": { "type": "string", "description": "Target ID.", - "example": "259125845563242502" + "example": "259125845563242502", + "default": "" }, "$createdAt": { "type": "string", "description": "Target creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Target update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Target Name.", - "example": "Apple iPhone 12" + "example": "Apple iPhone 12", + "default": "" }, "userId": { "type": "string", "description": "User ID.", - "example": "259125845563242502" + "example": "259125845563242502", + "default": "" }, "providerId": { "type": "string", "description": "Provider ID.", "example": "259125845563242502", + "default": "", "nullable": true }, "providerType": { "type": "string", "description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.", - "example": "email" + "example": "email", + "default": "" }, "identifier": { "type": "string", "description": "The target identifier.", - "example": "token" + "example": "token", + "default": "" }, "expired": { "type": "boolean", "description": "Is the target expired.", - "example": false + "example": false, + "default": false } }, "required": [ @@ -147339,37 +149468,44 @@ "$id": { "type": "string", "description": "Migration ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Migration creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Variable creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "status": { "type": "string", "description": "Migration status ( pending, processing, failed, completed ) ", - "example": "pending" + "example": "pending", + "default": "" }, "stage": { "type": "string", "description": "Migration stage ( init, processing, source-check, destination-check, migrating, finished )", - "example": "init" + "example": "init", + "default": "" }, "source": { "type": "string", "description": "A string containing the type of source of the migration.", - "example": "Appwrite" + "example": "Appwrite", + "default": "" }, "destination": { "type": "string", "description": "A string containing the type of destination of the migration.", - "example": "Appwrite" + "example": "Appwrite", + "default": "Appwrite" }, "resources": { "type": "array", @@ -147379,52 +149515,62 @@ }, "example": [ "user" - ] + ], + "default": [] }, "resourceId": { "type": "string", "description": "ID of the resource being migrated.", - "example": "collectionId" + "example": "collectionId", + "default": "" }, "resourceInternalId": { "type": "string", "description": "Internal ID of the resource being migrated.", - "example": "1" + "example": "1", + "default": "" }, "resourceType": { "type": "string", "description": "Type of the resource being migrated.", - "example": "collection" + "example": "collection", + "default": "" }, "parentResourceId": { "type": "string", "description": "ID of the parent resource that contains the migrated resource.", - "example": "databaseId" + "example": "databaseId", + "default": "" }, "parentResourceInternalId": { "type": "string", "description": "Internal ID of the parent resource that contains the migrated resource.", - "example": "1" + "example": "1", + "default": "" }, "parentResourceType": { "type": "string", "description": "Type of the parent resource that contains the migrated resource.", - "example": "database" + "example": "database", + "default": "" }, "destinationResourceId": { "type": "string", "description": "ID of the destination resource created or overwritten by the migration.", - "example": "databaseId" + "example": "databaseId", + "default": "" }, "destinationResourceInternalId": { "type": "string", "description": "Internal ID of the destination resource created or overwritten by the migration.", - "example": "1" + "example": "1", + "default": "" }, "destinationResourceType": { "type": "string", "description": "Type of the destination resource created or overwritten by the migration.", - "example": "database" + "example": "database", + "default": "" }, "statusCounters": { "type": "object", @@ -147439,7 +149585,8 @@ "PROCESSING": 0, "WARNING": 0 } - } + }, + "default": {} }, "resourceData": { "type": "array", @@ -147454,7 +149601,8 @@ "status": "SUCCESS", "message": "" } - ] + ], + "default": [] }, "errors": { "type": "array", @@ -147462,7 +149610,8 @@ "items": { "type": "string" }, - "example": [] + "example": [], + "default": [] }, "options": { "type": "object", @@ -147471,7 +149620,8 @@ "example": { "bucketId": "exports", "notify": false - } + }, + "default": {} } }, "required": [ @@ -147531,168 +149681,196 @@ "type": "integer", "description": "Number of users to be migrated.", "format": "int32", - "example": 20 + "example": 20, + "default": 0 }, "team": { "type": "integer", "description": "Number of teams to be migrated.", "format": "int32", - "example": 20 + "example": 20, + "default": 0 }, "database": { "type": "integer", "description": "Number of databases to be migrated.", "format": "int32", - "example": 20 + "example": 20, + "default": 0 }, "row": { "type": "integer", "description": "Number of rows to be migrated.", "format": "int32", - "example": 20 + "example": 20, + "default": 0 }, "file": { "type": "integer", "description": "Number of files to be migrated.", "format": "int32", - "example": 20 + "example": 20, + "default": 0 }, "bucket": { "type": "integer", "description": "Number of buckets to be migrated.", "format": "int32", - "example": 20 + "example": 20, + "default": 0 }, "function": { "type": "integer", "description": "Number of functions to be migrated.", "format": "int32", - "example": 20 + "example": 20, + "default": 0 }, "platform": { "type": "integer", "description": "Number of platforms to be migrated.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "api-key": { "type": "integer", "description": "Number of API keys to be migrated.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "project-variable": { "type": "integer", "description": "Number of project variables to be migrated.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "webhook": { "type": "integer", "description": "Number of webhooks to be migrated.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "auth-methods": { "type": "integer", "description": "Number of auth-method configs to be migrated (always 0 or 1 \u2014 the project-level flag bundle).", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "project-protocols": { "type": "integer", "description": "Number of protocol configs to be migrated (always 0 or 1 \u2014 the project-level REST\/GraphQL\/WebSocket flags).", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "project-labels": { "type": "integer", "description": "Number of label sets to be migrated (always 0 or 1 \u2014 the project-level RBAC label array).", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "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).", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "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).", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "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).", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "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.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "project-email-template": { "type": "integer", "description": "Number of custom email templates to be migrated (one per templateId \u00d7 locale pair).", "format": "int32", - "example": 7 + "example": 7, + "default": 0 }, "site": { "type": "integer", "description": "Number of sites to be migrated.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "provider": { "type": "integer", "description": "Number of providers to be migrated.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "topic": { "type": "integer", "description": "Number of topics to be migrated.", "format": "int32", - "example": 10 + "example": 10, + "default": 0 }, "subscriber": { "type": "integer", "description": "Number of subscribers to be migrated.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "message": { "type": "integer", "description": "Number of messages to be migrated.", "format": "int32", - "example": 50 + "example": 50, + "default": 0 }, "size": { "type": "integer", "description": "Size of files to be migrated in mb.", "format": "int32", - "example": 30000 + "example": 30000, + "default": 0 }, "version": { "type": "string", "description": "Version of the Appwrite instance to be migrated.", - "example": "1.4.0" + "example": "1.4.0", + "default": "" }, "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.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "backup-policy": { "type": "integer", "description": "Number of backup policies to be migrated.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 } }, "required": [ @@ -147763,67 +149941,80 @@ "$id": { "type": "string", "description": "Insight ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Insight creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Insight update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "reportId": { "type": "string", "description": "Parent report ID. Insights always belong to a report.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "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).", - "example": "tablesDBIndex" + "example": "tablesDBIndex", + "default": "" }, "severity": { "type": "string", "description": "Insight severity. One of info, warning, critical.", - "example": "warning" + "example": "warning", + "default": "info" }, "status": { "type": "string", "description": "Insight status. One of active, dismissed.", - "example": "active" + "example": "active", + "default": "active" }, "resourceType": { "type": "string", "description": "Type of the resource the insight is about. Plural noun, e.g. databases, sites, functions.", - "example": "databases" + "example": "databases", + "default": "" }, "resourceId": { "type": "string", "description": "ID of the resource the insight is about.", - "example": "main" + "example": "main", + "default": "" }, "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.", - "example": "tables" + "example": "tables", + "default": "" }, "parentResourceId": { "type": "string", "description": "ID of the parent resource. Empty when the resource has no parent.", - "example": "orders" + "example": "orders", + "default": "" }, "title": { "type": "string", "description": "Insight title.", - "example": "Missing index on collection orders" + "example": "Missing index on collection orders", + "default": "" }, "summary": { "type": "string", "description": "Short markdown summary describing the insight.", - "example": "Queries against `orders.status` are scanning the full collection." + "example": "Queries against `orders.status` are scanning the full collection.", + "default": "" }, "ctas": { "type": "array", @@ -147849,6 +150040,7 @@ "type": "string", "description": "User ID that dismissed the insight. Empty when not dismissed.", "example": "5e5ea5c16897e", + "default": "", "nullable": true } }, @@ -147895,17 +150087,20 @@ "label": { "type": "string", "description": "Human-readable label for the CTA, used in UI.", - "example": "Create missing index" + "example": "Create missing index", + "default": "" }, "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.", - "example": "tablesDB" + "example": "tablesDB", + "default": "" }, "method": { "type": "string", "description": "Public API method on the chosen service the client should invoke when this CTA is triggered.", - "example": "createIndex" + "example": "createIndex", + "default": "" }, "params": { "type": "object", @@ -147919,7 +150114,8 @@ "columns": [ "status" ] - } + }, + "default": {} } }, "required": [ @@ -147950,47 +150146,56 @@ "$id": { "type": "string", "description": "Report ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Report creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Report update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "appId": { "type": "string", "description": "ID of the third-party app that submitted the report.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "type": { "type": "string", "description": "Analyzer that produced this report. e.g. lighthouse, audit, databaseAnalyzer.", - "example": "lighthouse" + "example": "lighthouse", + "default": "" }, "title": { "type": "string", "description": "Short, human-readable title for the report.", - "example": "Lighthouse audit for https:\/\/appwrite.io\/" + "example": "Lighthouse audit for https:\/\/appwrite.io\/", + "default": "" }, "summary": { "type": "string", "description": "Markdown summary describing the report.", - "example": "Performance score 78. 4 opportunities found." + "example": "Performance score 78. 4 opportunities found.", + "default": "" }, "targetType": { "type": "string", "description": "Plural noun describing what the report analyzes, e.g. databases, sites, urls.", - "example": "urls" + "example": "urls", + "default": "" }, "target": { "type": "string", "description": "Free-form target identifier (URL for lighthouse, resource ID for db).", - "example": "https:\/\/appwrite.io\/" + "example": "https:\/\/appwrite.io\/", + "default": "" }, "categories": { "type": "array", @@ -148001,7 +150206,8 @@ "example": [ "performance", "accessibility" - ] + ], + "default": [] }, "insights": { "type": "array", @@ -148056,147 +150262,176 @@ "$id": { "type": "string", "description": "Event ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "actorType": { "type": "string", "description": "Actor type.", - "example": "user" + "example": "user", + "default": "" }, "actorId": { "type": "string", "description": "Actor ID.", - "example": "610fc2f985ee0" + "example": "610fc2f985ee0", + "default": "" }, "actorEmail": { "type": "string", "description": "Actor Email.", - "example": "john@appwrite.io" + "example": "john@appwrite.io", + "default": "" }, "actorName": { "type": "string", "description": "Actor Name.", - "example": "John Doe" + "example": "John Doe", + "default": "" }, "resourceParent": { "type": "string", "description": "Resource parent.", - "example": "database\/ID" + "example": "database\/ID", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type.", - "example": "collection" + "example": "collection", + "default": "" }, "resourceId": { "type": "string", "description": "Resource ID.", - "example": "610fc2f985ee0" + "example": "610fc2f985ee0", + "default": "" }, "resource": { "type": "string", "description": "Resource.", - "example": "collections\/610fc2f985ee0" + "example": "collections\/610fc2f985ee0", + "default": "" }, "event": { "type": "string", "description": "Event name.", - "example": "account.sessions.create" + "example": "account.sessions.create", + "default": "" }, "userAgent": { "type": "string", "description": "User agent.", - "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", + "default": "" }, "ip": { "type": "string", "description": "IP address.", - "example": "127.0.0.1" + "example": "127.0.0.1", + "default": "" }, "mode": { "type": "string", "description": "API mode when event triggered.", - "example": "admin" + "example": "admin", + "default": "" }, "country": { "type": "string", "description": "Location.", - "example": "US" + "example": "US", + "default": "" }, "continentCode": { "type": "string", "description": "Continent code.", - "example": "NA" + "example": "NA", + "default": "" }, "city": { "type": "string", "description": "City name.", - "example": "Mountain View" + "example": "Mountain View", + "default": "" }, "subdivisions": { "type": "string", "description": "Region\/state chain.", - "example": "California" + "example": "California", + "default": "" }, "isp": { "type": "string", "description": "Internet service provider.", - "example": "Google" + "example": "Google", + "default": "" }, "autonomousSystemNumber": { "type": "string", "description": "Autonomous System Number (ASN).", - "example": "15169" + "example": "15169", + "default": "" }, "autonomousSystemOrganization": { "type": "string", "description": "Organization that owns the ASN.", - "example": "GOOGLE" + "example": "GOOGLE", + "default": "" }, "connectionType": { "type": "string", "description": "Connection type (e.g. cable, cellular, corporate).", - "example": "cable" + "example": "cable", + "default": "" }, "connectionUsageType": { "type": "string", "description": "User type (e.g. residential, business, hosting).", - "example": "residential" + "example": "residential", + "default": "" }, "connectionOrganization": { "type": "string", "description": "Registered organization of the IP.", - "example": "Google LLC" + "example": "Google LLC", + "default": "" }, "time": { "type": "string", "description": "Log creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "projectId": { "type": "string", "description": "Project ID.", - "example": "610fc2f985ee0" + "example": "610fc2f985ee0", + "default": "" }, "teamId": { "type": "string", "description": "Team ID.", - "example": "610fc2f985ee0" + "example": "610fc2f985ee0", + "default": "" }, "hostname": { "type": "string", "description": "Hostname.", - "example": "appwrite.io" + "example": "appwrite.io", + "default": "" }, "sdk": { "type": "string", "description": "Name of the SDK that triggered the event.", - "example": "web" + "example": "web", + "default": "" }, "sdkVersion": { "type": "string", "description": "Version of the SDK that triggered the event.", - "example": "14.0.0" + "example": "14.0.0", + "default": "" } }, "required": [ @@ -148269,34 +150504,40 @@ "name": { "type": "string", "description": "Resource name", - "example": "" + "example": "", + "default": "" }, "unit": { "type": "string", "description": "Resource unit", - "example": "GB" + "example": "GB", + "default": "" }, "currency": { "type": "string", "description": "Price currency", - "example": "USD" + "example": "USD", + "default": "" }, "price": { "type": "number", "description": "Price", "format": "double", - "example": 5 + "example": 5, + "default": 0 }, "value": { "type": "integer", "description": "Resource value", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "invoiceDesc": { "type": "string", "description": "Description on invoice", - "example": "" + "example": "", + "default": "" } }, "required": [ @@ -148323,17 +150564,20 @@ "$id": { "type": "string", "description": "Addon ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Addon creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Addon update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -148343,33 +150587,39 @@ }, "example": [ "read(\"any\")" - ] + ], + "default": [] }, "key": { "type": "string", "description": "Addon key", - "example": "baa" + "example": "baa", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type (organization or project)", - "example": "organization" + "example": "organization", + "default": "" }, "resourceId": { "type": "string", "description": "Resource ID", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "status": { "type": "string", "description": "Payment status. Possible values: pending (awaiting payment confirmation e.g. 3DS), active (payment confirmed and addon is running).", - "example": "active" + "example": "active", + "default": "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.", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "nextValue": { "type": "integer", @@ -148411,46 +150661,54 @@ "addonKey": { "type": "string", "description": "Addon key.", - "example": "baa" + "example": "baa", + "default": "" }, "name": { "type": "string", "description": "Addon display name.", - "example": "HIPAA BAA" + "example": "HIPAA BAA", + "default": "" }, "monthlyPrice": { "type": "number", "description": "Full monthly price of the addon.", "format": "double", - "example": 350 + "example": 350, + "default": 0 }, "proratedAmount": { "type": "number", "description": "Calculated prorated amount for the current billing cycle.", "format": "double", - "example": 175.5 + "example": 175.5, + "default": 0 }, "remainingDays": { "type": "integer", "description": "Days remaining in the current billing cycle.", "format": "int32", - "example": 15 + "example": 15, + "default": 0 }, "totalCycleDays": { "type": "integer", "description": "Total days in the billing cycle.", "format": "int32", - "example": 30 + "example": 30, + "default": 0 }, "currency": { "type": "string", "description": "Currency code.", - "example": "USD" + "example": "USD", + "default": "USD" }, "billingCycleEnd": { "type": "string", "description": "When the current billing cycle ends.", - "example": "2024-02-01T00:00:00.000+00:00" + "example": "2024-02-01T00:00:00.000+00:00", + "default": "" } }, "required": [ @@ -148481,32 +150739,38 @@ "$id": { "type": "string", "description": "Link ID. This is the shareable referral code.", - "example": "my-campaign" + "example": "my-campaign", + "default": "" }, "$createdAt": { "type": "string", "description": "Link creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Link update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "User ID of the link owner.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "Optional link name.", - "example": "Launch campaign" + "example": "Launch campaign", + "default": "" }, "status": { "type": "string", "description": "Link status. Can be one of `active` or `disabled`.", - "example": "active" + "example": "active", + "default": "" } }, "required": [ @@ -148534,7 +150798,8 @@ "type": "integer", "description": "Total number of links that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "links": { "type": "array", @@ -148561,47 +150826,56 @@ "$id": { "type": "string", "description": "Referral ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Referral creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Referral update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "linkId": { "type": "string", "description": "Affiliate link ID used for attribution.", - "example": "my-campaign" + "example": "my-campaign", + "default": "" }, "referredUserMaskedId": { "type": "string", "description": "Privacy-safe truncated referred user ID.", - "example": "****97e" + "example": "****97e", + "default": "" }, "referredUserCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the referred user at signup, when available.", - "example": "us" + "example": "us", + "default": "" }, "status": { "type": "string", "description": "Referral status. Can be one of `pending`, `converted`, or `expired`. `expired` is derived from `expiresAt` when still pending.", - "example": "pending" + "example": "pending", + "default": "" }, "attributedAt": { "type": "string", "description": "Attribution time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "expiresAt": { "type": "string", "description": "Attribution expiry time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "convertedAt": { "type": "string", @@ -148642,7 +150916,8 @@ "type": "integer", "description": "Total number of referrals that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "referrals": { "type": "array", @@ -148669,43 +150944,51 @@ "$id": { "type": "string", "description": "Reward ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Reward creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Reward update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "User ID of the reward owner.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "linkId": { "type": "string", "description": "Affiliate link ID that earned this reward.", - "example": "my-campaign" + "example": "my-campaign", + "default": "" }, "referralId": { "type": "string", "description": "Referral ID that earned this reward.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "amount": { "type": "number", "description": "Reward amount in USD.", "format": "double", - "example": 10 + "example": 10, + "default": 0 }, "status": { "type": "string", "description": "Reward status. Can be one of `pending` or `claimed`.", - "example": "pending" + "example": "pending", + "default": "" }, "teamId": { "type": "string", @@ -148751,7 +151034,8 @@ "type": "integer", "description": "Total number of rewards that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "rewards": { "type": "array", @@ -148778,23 +151062,27 @@ "$id": { "type": "string", "description": "Aggregation ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "Project name", - "example": "" + "example": "", + "default": "" }, "region": { "type": "string", "description": "Project region", - "example": "fra" + "example": "fra", + "default": "fra" }, "amount": { "type": "integer", "description": "Aggregated amount", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "resources": { "type": "array", @@ -148840,13 +151128,15 @@ "type": "integer", "description": "Unique visitors in the requested range.", "format": "int32", - "example": 1234 + "example": 1234, + "default": 0 }, "sessions": { "type": "integer", "description": "Unique sessions in the requested range.", "format": "int32", - "example": 4567 + "example": 4567, + "default": 0 }, "pageviews": { "type": "integer", @@ -148859,7 +151149,8 @@ "type": "integer", "description": "Total events in the requested range.", "format": "int32", - "example": 8910 + "example": 8910, + "default": 0 }, "visits": { "type": "integer", @@ -148932,7 +151223,8 @@ "type": "integer", "description": "Total number of metric rows returned.", "format": "int32", - "example": 30 + "example": 30, + "default": 0 }, "metrics": { "type": "array", @@ -148959,37 +151251,44 @@ "$id": { "type": "string", "description": "Analytics property ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Property creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Property update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Human-readable name of the tracked website or application.", - "example": "My Website" + "example": "My Website", + "default": "" }, "domain": { "type": "string", "description": "Primary domain being tracked (e.g. example.com). May be empty for native apps.", - "example": "example.com" + "example": "example.com", + "default": "" }, "enabled": { "type": "boolean", "description": "Whether tracking is currently active.", - "example": true + "example": true, + "default": true }, "public": { "type": "boolean", "description": "Whether stats for this property are publicly viewable.", - "example": false + "example": false, + "default": false }, "allowedOrigins": { "type": "array", @@ -148999,17 +151298,22 @@ }, "example": [ "https:\/\/example.com" + ], + "default": [ + "*" ] }, "accessedAt": { "type": "string", "description": "Most recent event date in ISO 8601 format. This attribute is only updated again after 24 hours.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "firstAccessedAt": { "type": "string", "description": "First event date in ISO 8601 format. Empty until the property receives its first event.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -149046,17 +151350,20 @@ "$id": { "type": "string", "description": "Aggregation ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Aggregation creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Aggregation update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -149066,154 +151373,180 @@ }, "example": [ "read(\"any\")" - ] + ], + "default": [] }, "from": { "type": "string", "description": "Beginning date of the invoice", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "to": { "type": "string", "description": "End date of the invoice", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "usageStorage": { "type": "integer", "description": "Total storage usage", "format": "int32", - "example": 20009090 + "example": 20009090, + "default": 0 }, "usageTotalStorage": { "type": "integer", "description": "Total storage usage with builds storage", "format": "int32", - "example": 20009090 + "example": 20009090, + "default": 0 }, "usageFilesStorage": { "type": "integer", "description": "Total files storage usage", "format": "int32", - "example": 20009090 + "example": 20009090, + "default": 0 }, "usageDeploymentsStorage": { "type": "integer", "description": "Total deployments storage usage", "format": "int32", - "example": 20009090 + "example": 20009090, + "default": 0 }, "usageBuildsStorage": { "type": "integer", "description": "Total builds storage usage", "format": "int32", - "example": 20009090 + "example": 20009090, + "default": 0 }, "usageDatabasesStorage": { "type": "integer", "description": "Total databases storage usage", "format": "int32", - "example": 2009090 + "example": 2009090, + "default": 0 }, "usageFunctionsStorage": { "type": "integer", "description": "Total functions storage usage, deployments and builds together. Supersedes usageDeploymentsStorage and usageBuildsStorage.", "format": "int32", - "example": 20009090 + "example": 20009090, + "default": 0 }, "usageSitesStorage": { "type": "integer", "description": "Total sites storage usage, deployments and builds together. Supersedes usageDeploymentsStorage and usageBuildsStorage.", "format": "int32", - "example": 20009090 + "example": 20009090, + "default": 0 }, "usageUsers": { "type": "integer", "description": "Total active users for the billing period", "format": "int32", - "example": 2000 + "example": 2000, + "default": 0 }, "usageExecutions": { "type": "integer", "description": "Total number of executions for the billing period", "format": "int32", - "example": 2000 + "example": 2000, + "default": 0 }, "usageBandwidth": { "type": "integer", "description": "Total bandwidth usage for the billing period", "format": "int32", - "example": 2000 + "example": 2000, + "default": 0 }, "usageRealtime": { "type": "integer", "description": "Peak concurrent realtime connections for the billing period", "format": "int32", - "example": 200 + "example": 200, + "default": 0 }, "usageRealtimeMessages": { "type": "integer", "description": "Total realtime messages sent for the billing period", "format": "int32", - "example": 10000 + "example": 10000, + "default": 0 }, "usageRealtimeBandwidth": { "type": "integer", "description": "Total realtime bandwidth usage for the billing period", "format": "int32", - "example": 5000000 + "example": 5000000, + "default": 0 }, "additionalMembers": { "type": "integer", "description": "Additional members", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "additionalMemberAmount": { "type": "integer", "description": "Additional members cost", "format": "int32", - "example": 30 + "example": 30, + "default": 0 }, "additionalStorageAmount": { "type": "integer", "description": "Additional storage usage cost", "format": "int32", - "example": 40 + "example": 40, + "default": 0 }, "additionalUsersAmount": { "type": "integer", "description": "Additional users usage cost.", "format": "int32", - "example": 4 + "example": 4, + "default": 0 }, "additionalExecutionsAmount": { "type": "integer", "description": "Additional executions usage cost", "format": "int32", - "example": 30 + "example": 30, + "default": 0 }, "additionalBandwidthAmount": { "type": "integer", "description": "Additional bandwidth usage cost", "format": "int32", - "example": 40 + "example": 40, + "default": 0 }, "additionalRealtimeAmount": { "type": "integer", "description": "Additional realtime usage cost", "format": "int32", - "example": 20 + "example": 20, + "default": 0 }, "plan": { "type": "string", "description": "Billing plan", - "example": "tier-0" + "example": "tier-0", + "default": "" }, "amount": { "type": "integer", "description": "Aggregated amount", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "breakdown": { "type": "array", @@ -149308,22 +151641,26 @@ "$id": { "type": "string", "description": "Archive ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Archive creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Archive update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "policyId": { "type": "string", "description": "Archive policy ID.", - "example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7", + "default": "" }, "size": { "type": "integer", @@ -149335,7 +151672,8 @@ "status": { "type": "string", "description": "The status of the archive creation. Possible values: pending, processing, uploading, completed, failed, skipped.", - "example": "completed" + "example": "completed", + "default": "" }, "startedAt": { "type": "string", @@ -149346,7 +151684,8 @@ "migrationId": { "type": "string", "description": "Migration ID.", - "example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7", + "default": "" }, "services": { "type": "array", @@ -149372,12 +151711,14 @@ "type": "string", "description": "The resource ID to backup. Set only if this archive should backup a single resource.", "example": "DB1", + "default": "", "nullable": true }, "resourceType": { "type": "string", "description": "The resource type to backup. Set only if this archive should backup a single resource.", "example": "database", + "default": "", "nullable": true } }, @@ -149413,58 +151754,69 @@ "$id": { "type": "string", "description": "Backup ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Backup creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "databaseId": { "type": "string", "description": "Database ID this backup belongs to.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "projectId": { "type": "string", "description": "Project ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "policyId": { "type": "string", "description": "Backup policy ID when the backup was created by a schedule.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "trigger": { "type": "string", "description": "Backup trigger. Possible values: manual, schedule.", - "example": "schedule" + "example": "schedule", + "default": "manual" }, "type": { "type": "string", "description": "Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup), wal (write-ahead log continuous archival).", - "example": "full" + "example": "full", + "default": "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.", - "example": "incremental" + "example": "incremental", + "default": "" }, "fallbackReason": { "type": "string", "description": "Why the backend ran a different backup type than the one requested. Empty when the backup ran as requested.", - "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.", + "default": "" }, "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).", - "example": "completed" + "example": "completed", + "default": "pending" }, "sizeBytes": { "type": "integer", "description": "Backup size in bytes.", "format": "int32", - "example": 1073741824 + "example": 1073741824, + "default": 0 }, "startedAt": { "type": "string", @@ -149494,12 +151846,14 @@ "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.", "example": "000000010000000000000003|0\/3000148", + "default": "", "nullable": true }, "error": { "type": "string", "description": "Error message if backup failed.", - "example": "" + "example": "", + "default": "" } }, "required": [ @@ -149544,7 +151898,8 @@ "type": "integer", "description": "Total number of backups.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "backups": { "type": "array", @@ -149571,27 +151926,32 @@ "provider": { "type": "string", "description": "Storage provider. Possible values: s3 (Amazon S3 or S3-compatible), gcs (Google Cloud Storage), azure (Azure Blob Storage).", - "example": "s3" + "example": "s3", + "default": "" }, "bucket": { "type": "string", "description": "Storage bucket or container name.", - "example": "my-backup-bucket" + "example": "my-backup-bucket", + "default": "" }, "region": { "type": "string", "description": "Storage region.", - "example": "us-east-1" + "example": "us-east-1", + "default": "" }, "prefix": { "type": "string", "description": "Object key prefix for backups.", - "example": "backups\/" + "example": "backups\/", + "default": "backups\/" }, "endpoint": { "type": "string", "description": "Custom endpoint for S3-compatible storage.", - "example": "https:\/\/minio.example.com" + "example": "https:\/\/minio.example.com", + "default": "" } }, "required": [ @@ -149616,17 +151976,20 @@ "$id": { "type": "string", "description": "Region ID", - "example": "eu-fr" + "example": "eu-fr", + "default": "" }, "userId": { "type": "string", "description": "User ID", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "streetAddress": { "type": "string", "description": "Street address", - "example": "13th Avenue" + "example": "13th Avenue", + "default": "" }, "addressLine2": { "type": "string", @@ -149637,12 +152000,14 @@ "country": { "type": "string", "description": "Address country", - "example": "USA" + "example": "USA", + "default": "" }, "city": { "type": "string", "description": "city", - "example": "" + "example": "", + "default": "" }, "state": { "type": "string", @@ -149684,6 +152049,7 @@ "description": "Bandwidth limit", "format": "int32", "example": 5, + "default": 0, "nullable": true }, "storage": { @@ -149691,6 +152057,7 @@ "description": "Storage limit", "format": "int32", "example": 150, + "default": 0, "nullable": true }, "users": { @@ -149698,6 +152065,7 @@ "description": "Users limit", "format": "int32", "example": 200000, + "default": 0, "nullable": true }, "executions": { @@ -149705,6 +152073,7 @@ "description": "Executions limit", "format": "int32", "example": 750000, + "default": 0, "nullable": true }, "GBHours": { @@ -149712,6 +152081,7 @@ "description": "GBHours limit", "format": "int32", "example": 100, + "default": 0, "nullable": true }, "imageTransformations": { @@ -149719,6 +152089,7 @@ "description": "Image transformations limit", "format": "int32", "example": 100, + "default": 0, "nullable": true }, "authPhone": { @@ -149726,6 +152097,7 @@ "description": "Auth phone limit", "format": "int32", "example": 10, + "default": 0, "nullable": true }, "budgetLimit": { @@ -149733,6 +152105,7 @@ "description": "Budget limit percentage", "format": "int32", "example": 100, + "default": 0, "nullable": true } }, @@ -149754,217 +152127,253 @@ "$id": { "type": "string", "description": "Plan ID.", - "example": "tier-0" + "example": "tier-0", + "default": "" }, "name": { "type": "string", "description": "Plan name", - "example": "Hobby" + "example": "Hobby", + "default": "" }, "desc": { "type": "string", "description": "Plan description", - "example": "Hobby plan" + "example": "Hobby plan", + "default": "" }, "order": { "type": "integer", "description": "Plan order", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "price": { "type": "number", "description": "Price", "format": "double", - "example": 25 + "example": 25, + "default": 0 }, "trial": { "type": "integer", "description": "Trial days", "format": "int32", - "example": 14 + "example": 14, + "default": 0 }, "bandwidth": { "type": "integer", "description": "Bandwidth", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "storage": { "type": "integer", "description": "Storage", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "imageTransformations": { "type": "integer", "description": "Image Transformations", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "screenshotsGenerated": { "type": "integer", "description": "Screenshots generated", "format": "int32", - "example": 50 + "example": 50, + "default": 0 }, "members": { "type": "integer", "description": "Members", "format": "int32", "example": 25, + "default": 0, "nullable": true }, "webhooks": { "type": "integer", "description": "Webhooks", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "wafRules": { "type": "integer", "description": "Maximum WAF rules per project", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "projects": { "type": "integer", "description": "Projects", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "platforms": { "type": "integer", "description": "Platforms", "format": "int32", - "example": 3 + "example": 3, + "default": 0 }, "users": { "type": "integer", "description": "Users", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "teams": { "type": "integer", "description": "Teams", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "databases": { "type": "integer", "description": "Databases", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "databasesReads": { "type": "integer", "description": "Database reads per month", "format": "int32", - "example": 500000 + "example": 500000, + "default": 0 }, "databasesWrites": { "type": "integer", "description": "Database writes per month", "format": "int32", - "example": 250000 + "example": 250000, + "default": 0 }, "databasesBatchSize": { "type": "integer", "description": "Database batch size limit", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "buckets": { "type": "integer", "description": "Buckets", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "fileSize": { "type": "integer", "description": "File size", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "functions": { "type": "integer", "description": "Functions", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "sites": { "type": "integer", "description": "Sites", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "executions": { "type": "integer", "description": "Function executions", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "executionsRetentionCount": { "type": "integer", "description": "Rolling max executions retained per function\/site", "format": "int32", - "example": 10000 + "example": 10000, + "default": 1000 }, "GBHours": { "type": "integer", "description": "GB hours for functions", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "realtime": { "type": "integer", "description": "Realtime connections", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "realtimeMessages": { "type": "integer", "description": "Realtime messages", "format": "int32", - "example": 100000 + "example": 100000, + "default": 0 }, "messages": { "type": "integer", "description": "Messages per month", "format": "int32", - "example": 1000 + "example": 1000, + "default": 0 }, "topics": { "type": "integer", "description": "Topics for messaging", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "authPhone": { "type": "integer", "description": "SMS authentications per month", "format": "int32", - "example": 10 + "example": 10, + "default": 0 }, "domains": { "type": "integer", "description": "Custom domains", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "activityLogs": { "type": "integer", "description": "Activity log days", "format": "int32", "example": 7, + "default": 1, "nullable": true }, "usageLogs": { "type": "integer", "description": "Usage history days", "format": "int32", - "example": 30 + "example": 30, + "default": 0 }, "usageLogsIntervals": { "type": "array", @@ -149977,6 +152386,11 @@ "1h", "1d" ], + "default": [ + "15m", + "1h", + "1d" + ], "nullable": true }, "usageAggregateOnlyMetrics": { @@ -149990,19 +152404,22 @@ "network.inbound", "network.outbound" ], + "default": [], "nullable": true }, "projectInactivityDays": { "type": "integer", "description": "Number of days of console inactivity before a project is paused. 0 means pausing is disabled.", "format": "int32", - "example": 7 + "example": 7, + "default": 0 }, "alertLimit": { "type": "integer", "description": "Alert threshold percentage", "format": "int32", - "example": 80 + "example": 80, + "default": 80 }, "usage": { "type": "object", @@ -150026,27 +152443,32 @@ "budgetCapEnabled": { "type": "boolean", "description": "Budget cap enabled or disabled.", - "example": true + "example": true, + "default": false }, "customSmtp": { "type": "boolean", "description": "Custom SMTP", - "example": true + "example": true, + "default": false }, "emailBranding": { "type": "boolean", "description": "Appwrite branding in email", - "example": true + "example": true, + "default": false }, "requiresPaymentMethod": { "type": "boolean", "description": "Does plan require payment method", - "example": true + "example": true, + "default": true }, "requiresBillingAddress": { "type": "boolean", "description": "Does plan require billing address", - "example": true + "example": true, + "default": false }, "eligibleCountries": { "type": "array", @@ -150058,83 +152480,99 @@ "IN", "NP" ], + "default": [], "nullable": true }, "isAvailable": { "type": "boolean", "description": "Is the billing plan available", - "example": true + "example": true, + "default": true }, "selfService": { "type": "boolean", "description": "Can user change the plan themselves", - "example": true + "example": true, + "default": true }, "premiumSupport": { "type": "boolean", "description": "Does plan enable premium support", - "example": true + "example": true, + "default": true }, "budgeting": { "type": "boolean", "description": "Does plan support budget cap", - "example": true + "example": true, + "default": true }, "supportsMockNumbers": { "type": "boolean", "description": "Does plan support mock numbers", - "example": true + "example": true, + "default": true }, "supportsOrganizationRoles": { "type": "boolean", "description": "Does plan support organization roles", - "example": true + "example": true, + "default": true }, "supportsCredits": { "type": "boolean", "description": "Does plan support credit", - "example": true + "example": true, + "default": false }, "supportsDedicatedDatabases": { "type": "boolean", "description": "Does plan support dedicated databases.", - "example": true + "example": true, + "default": false }, "supportsDisposableEmailValidation": { "type": "boolean", "description": "Does plan support blocking disposable email addresses.", - "example": true + "example": true, + "default": false }, "supportsCanonicalEmailValidation": { "type": "boolean", "description": "Does plan support requiring canonical email addresses.", - "example": true + "example": true, + "default": false }, "supportsFreeEmailValidation": { "type": "boolean", "description": "Does plan support blocking free email addresses.", - "example": true + "example": true, + "default": false }, "supportsCorporateEmailValidation": { "type": "boolean", "description": "Does plan support restricting sign-ups to corporate email addresses only.", - "example": true + "example": true, + "default": false }, "supportsProjectSpecificRoles": { "type": "boolean", "description": "Does plan support project-specific member roles.", - "example": true + "example": true, + "default": false }, "backupsEnabled": { "type": "boolean", "description": "Does plan support backup policies.", "example": true, + "default": true, "nullable": true }, "usagePerProject": { "type": "boolean", "description": "Whether usage addons are calculated per project.", - "example": true + "example": true, + "default": true }, "supportedAddons": { "type": "object", @@ -150150,24 +152588,35 @@ "description": "How many policies does plan support", "format": "int32", "example": 1, + "default": 0, "nullable": true }, "deploymentSize": { "type": "integer", "description": "Maximum function and site deployment size in MB", "format": "int32", - "example": 30 + "example": 30, + "default": 0 }, "buildSize": { "type": "integer", "description": "Maximum function and site deployment size in MB", "format": "int32", - "example": 2000 + "example": 2000, + "default": 0 + }, + "functionsIntervalMinimum": { + "type": "integer", + "description": "Shortest function schedule interval allowed, in minutes. 0 allows every interval.", + "format": "int32", + "example": 60, + "default": 0 }, "databasesAllowEncrypt": { "type": "boolean", "description": "Does the plan support encrypted string attributes or not.", - "example": false + "example": false, + "default": false }, "limits": { "type": "object", @@ -150228,7 +152677,8 @@ "type": "number", "description": "Included monthly dedicated-database compute credit in USD. Resets each billing cycle with no roll-over.", "format": "double", - "example": 10 + "example": 10, + "default": 0 }, "dedicatedDatabases": { "type": "object", @@ -150301,6 +152751,7 @@ "supportedAddons", "deploymentSize", "buildSize", + "functionsIntervalMinimum", "databasesAllowEncrypt", "group", "databaseComputeCredit" @@ -150384,6 +152835,7 @@ "backupPolicies": 1, "deploymentSize": 30, "buildSize": 2000, + "functionsIntervalMinimum": 60, "databasesAllowEncrypt": false, "limits": null, "group": "pro", @@ -150429,47 +152881,55 @@ "supported": { "type": "boolean", "description": "Is the addon supported in the plan?", - "example": true + "example": true, + "default": false }, "planIncluded": { "type": "integer", "description": "Addon plan included value", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "limit": { "type": "integer", "description": "Addon limit", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "type": { "type": "string", "description": "Addon type", - "example": "numeric" + "example": "numeric", + "default": "numeric" }, "currency": { "type": "string", "description": "Price currency", "example": "USD", + "default": "", "nullable": true }, "price": { "type": "number", "description": "Price", "format": "double", - "example": 5 + "example": 5, + "default": 0 }, "value": { "type": "integer", "description": "Resource value", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "invoiceDesc": { "type": "string", "description": "Description on invoice", - "example": "" + "example": "", + "default": "" } }, "required": [ @@ -150501,6 +152961,7 @@ "description": "Credits limit per billing cycle", "format": "int32", "example": 100, + "default": 0, "nullable": true }, "dailyCredits": { @@ -150508,6 +152969,7 @@ "description": "Daily credits limit (if applicable)", "format": "int32", "example": 5, + "default": 0, "nullable": true } }, @@ -150525,6 +152987,7 @@ "description": "Minimum CPU allocation in millicores.", "format": "int32", "example": 125, + "default": 0, "nullable": true }, "maxCpu": { @@ -150532,6 +152995,7 @@ "description": "Maximum CPU allocation in millicores.", "format": "int32", "example": 32000, + "default": 0, "nullable": true }, "minMemoryMb": { @@ -150539,6 +153003,7 @@ "description": "Minimum memory allocation in megabytes.", "format": "int32", "example": 128, + "default": 0, "nullable": true }, "maxMemoryMb": { @@ -150546,6 +153011,7 @@ "description": "Maximum memory allocation in megabytes.", "format": "int32", "example": 262144, + "default": 0, "nullable": true }, "minStorageGb": { @@ -150553,6 +153019,7 @@ "description": "Minimum storage allocation in gigabytes.", "format": "int32", "example": 1, + "default": 0, "nullable": true }, "maxStorageGb": { @@ -150560,6 +153027,7 @@ "description": "Maximum storage allocation in gigabytes.", "format": "int32", "example": 16384, + "default": 0, "nullable": true }, "maxReplicas": { @@ -150567,6 +153035,7 @@ "description": "Maximum number of high-availability replicas per dedicated database.", "format": "int32", "example": 5, + "default": 0, "nullable": true }, "maxConnections": { @@ -150574,6 +153043,7 @@ "description": "Maximum number of client connections.", "format": "int32", "example": 10000, + "default": 0, "nullable": true }, "maxIpAllowlistSize": { @@ -150581,6 +153051,7 @@ "description": "Maximum number of entries allowed in the IP allowlist.", "format": "int32", "example": 100, + "default": 0, "nullable": true }, "maxExtensions": { @@ -150588,6 +153059,7 @@ "description": "Maximum number of database extensions that can be enabled.", "format": "int32", "example": 50, + "default": 0, "nullable": true }, "maxBackupRetentionDays": { @@ -150595,6 +153067,7 @@ "description": "Maximum number of days a backup can be retained.", "format": "int32", "example": 365, + "default": 0, "nullable": true }, "maxPitrRetentionDays": { @@ -150602,6 +153075,7 @@ "description": "Maximum number of days of point-in-time recovery data that can be retained.", "format": "int32", "example": 35, + "default": 0, "nullable": true }, "maxSqlApiMaxRows": { @@ -150609,6 +153083,7 @@ "description": "Maximum number of rows a single SQL API query can return.", "format": "int32", "example": 1000000, + "default": 0, "nullable": true }, "maxSqlApiMaxBytes": { @@ -150616,6 +153091,7 @@ "description": "Maximum response size in bytes for a single SQL API query.", "format": "int32", "example": 104857600, + "default": 0, "nullable": true }, "maxSqlApiTimeoutSeconds": { @@ -150623,6 +153099,7 @@ "description": "Maximum execution time in seconds for a single SQL API query.", "format": "int32", "example": 300, + "default": 0, "nullable": true }, "maxSqlApiAllowedStatements": { @@ -150630,6 +153107,7 @@ "description": "Maximum number of SQL statement types that can be permitted through the SQL API.", "format": "int32", "example": 10, + "default": 0, "nullable": true }, "allowedSqlStatements": { @@ -150645,6 +153123,7 @@ "delete", "explain" ], + "default": [], "nullable": true }, "allowedStorageClasses": { @@ -150656,6 +153135,7 @@ "example": [ "ssd" ], + "default": [], "nullable": true }, "allowedSyncModes": { @@ -150669,6 +153149,7 @@ "sync", "quorum" ], + "default": [], "nullable": true } }, @@ -150713,17 +153194,20 @@ "baa": { "type": "boolean", "description": "Whether the plan supports BAA (Business Associate Agreement) addon", - "example": true + "example": true, + "default": false }, "premiumGeoDB": { "type": "boolean", "description": "Whether the plan supports Premium Geo DB addon (project-level)", - "example": true + "example": true, + "default": false }, "premiumGeoDBOrg": { "type": "boolean", "description": "Whether the plan supports Premium Geo DB addon (organization-level)", - "example": true + "example": true, + "default": false } }, "required": [ @@ -150744,22 +153228,26 @@ "$createdAt": { "type": "string", "description": "Block creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type that is blocked", - "example": "project" + "example": "project", + "default": "" }, "resourceId": { "type": "string", "description": "Resource identifier that is blocked", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "mode": { "type": "string", "description": "Block mode. full blocks reads and writes; readOnly blocks writes only.", - "example": "readOnly" + "example": "readOnly", + "default": "full" }, "expiredAt": { "type": "string", @@ -150789,28 +153277,33 @@ "branchId": { "type": "string", "description": "Branch identifier.", - "example": "a1b2c3d4" + "example": "a1b2c3d4", + "default": "" }, "branchName": { "type": "string", "description": "Branch name.", - "example": "branch-a1b2c3d4" + "example": "branch-a1b2c3d4", + "default": "" }, "namespace": { "type": "string", "description": "Kubernetes namespace where the branch is deployed.", - "example": "db-myproject-mydb-branch-a1b2c3d4" + "example": "db-myproject-mydb-branch-a1b2c3d4", + "default": "" }, "expiresAt": { "type": "integer", "description": "Unix timestamp when the branch expires.", "format": "int32", - "example": 1711411200 + "example": 1711411200, + "default": 0 }, "host": { "type": "string", "description": "Branch hostname for direct connections.", - "example": "db-myproject-mydb-a1b2c3d4.fra.appwrite.center" + "example": "db-myproject-mydb-a1b2c3d4.fra.appwrite.center", + "default": "" }, "port": { "type": "integer", @@ -150822,32 +153315,38 @@ "database": { "type": "string", "description": "Advertised catalog the client connects to. MySQL\/MariaDB use default; Postgres uses the routing label.", - "example": "db-myproject-mydb-a1b2c3d4" + "example": "db-myproject-mydb-a1b2c3d4", + "default": "" }, "username": { "type": "string", "description": "Database username. Shared with the parent database.", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "password": { "type": "string", "description": "Database password. Shared with the parent database.", - "example": "********" + "example": "********", + "default": "" }, "ssl": { "type": "boolean", "description": "Whether SSL is required.", - "example": false + "example": false, + "default": false }, "engine": { "type": "string", "description": "Database engine. Possible values: postgresql, mysql, mongodb.", - "example": "postgresql" + "example": "postgresql", + "default": "" }, "connectionString": { "type": "string", "description": "Full connection string for the branch.", - "example": "postgresql:\/\/appwrite:****@db-myproject-mydb-a1b2c3d4.fra.appwrite.center:5432\/db-myproject-mydb-a1b2c3d4?sslmode=require" + "example": "postgresql:\/\/appwrite:****@db-myproject-mydb-a1b2c3d4.fra.appwrite.center:5432\/db-myproject-mydb-a1b2c3d4?sslmode=require", + "default": "" } }, "required": [ @@ -150886,7 +153385,8 @@ "type": "integer", "description": "Total number of branches.", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "branches": { "type": "array", @@ -150913,51 +153413,60 @@ "$id": { "type": "string", "description": "Campaign ID", - "example": "" + "example": "", + "default": "" }, "template": { "type": "string", "description": "Campaign template", - "example": "" + "example": "", + "default": "" }, "title": { "type": "string", "description": "Campaign title", - "example": "" + "example": "", + "default": "" }, "description": { "type": "string", "description": "Campaign description", - "example": "" + "example": "", + "default": "" }, "plan": { "type": "string", "description": "Billing plan campaign is associated with", "example": "", + "default": "", "nullable": true }, "cta": { "type": "string", "description": "Campaign CTA", "example": "", + "default": "", "nullable": true }, "claimed": { "type": "string", "description": "Campaign info when claimed", "example": "", + "default": "", "nullable": true }, "unclaimed": { "type": "string", "description": "Campaign infor when unclaimed", "example": "", + "default": "", "nullable": true }, "image": { "type": "object", "additionalProperties": true, - "description": "Campaign images" + "description": "Campaign images", + "default": {} }, "reviews": { "type": "array", @@ -150971,11 +153480,13 @@ "onlyNewOrgs": { "type": "boolean", "description": "Campaign valid only for new orgs.", + "default": false, "nullable": true }, "footer": { "type": "boolean", "description": "Is footer", + "default": false, "nullable": true } }, @@ -151007,23 +153518,27 @@ "$id": { "type": "string", "description": "coupon ID", - "example": "NEWBONUS" + "example": "NEWBONUS", + "default": "" }, "code": { "type": "string", "description": "coupon ID", - "example": "NEWBONUS" + "example": "NEWBONUS", + "default": "" }, "credits": { "type": "number", "description": "Provided credit amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 }, "expiration": { "type": "string", "description": "Coupon expiration time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "validity": { "type": "integer", @@ -151034,17 +153549,20 @@ "campaign": { "type": "string", "description": "Campaign the coupon is associated with`.", - "example": "AppwriteHeroes" + "example": "AppwriteHeroes", + "default": "" }, "status": { "type": "string", "description": "Status of the coupon. Can be one of `disabled`, `active` or `expired`.", - "example": "disabled" + "example": "disabled", + "default": "" }, "onlyNewOrgs": { "type": "boolean", "description": "If the coupon is only valid for new organizations or not.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -151075,17 +153593,20 @@ "$id": { "type": "string", "description": "Credit ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Credit creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Credit update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -151095,44 +153616,52 @@ }, "example": [ "read(\"any\")" - ] + ], + "default": [] }, "couponId": { "type": "string", "description": "coupon ID", - "example": "NEWBONUS" + "example": "NEWBONUS", + "default": "" }, "userId": { "type": "string", "description": "ID of the User.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "teamId": { "type": "string", "description": "ID of the Team.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "credits": { "type": "number", "description": "Provided credit amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 }, "total": { "type": "number", "description": "Provided credit amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 }, "expiration": { "type": "string", "description": "Credit expiration time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "status": { "type": "string", "description": "Status of the credit. Can be one of `disabled`, `active` or `expired`.", - "example": "disabled" + "example": "disabled", + "default": "" } }, "required": [ @@ -151172,7 +153701,8 @@ "type": "integer", "description": "Total available credits for the organization.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 } }, "required": [ @@ -151200,13 +153730,15 @@ "type": "integer", "description": "Total number of credits", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "available": { "type": "number", "description": "Total available credit balance in USD", "format": "double", - "example": 5 + "example": 5, + "default": 0 } }, "required": [ @@ -151227,90 +153759,107 @@ "$id": { "type": "string", "description": "Database migration ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Migration creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Migration update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "projectId": { "type": "string", "description": "Project ID that owns the migrating database.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "databaseId": { "type": "string", "description": "Logical database ID being migrated.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "specification": { "type": "string", "description": "Dedicated compute specification provisioned for the migration target.", - "example": "s-2vcpu-4gb" + "example": "s-2vcpu-4gb", + "default": "" }, "phase": { "type": "string", "description": "Migration phase. Possible values: pending, provisioned, capturing, backfilling, catching_up, verifying, ready_to_cutover, cutover, soaking, done, failed, rolled_back.", - "example": "pending" + "example": "pending", + "default": "pending" }, "attempt": { "type": "integer", "description": "Number of times a migration step has failed and been recorded.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "lastError": { "type": "string", "description": "Reason the most recent migration step failed, empty while none has.", - "example": "" + "example": "", + "default": "" }, "lagDocuments": { "type": "integer", "description": "Number of documents still pending replication to the target.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "changelogWatermark": { "type": "integer", "description": "Highest source changelog sequence applied to the target so far.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "verifiedAt": { "type": "string", "description": "Time the migrated data was verified against the source in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "cutoverAt": { "type": "string", "description": "Time routing was flipped to the target in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "soakUntil": { "type": "string", "description": "Time the post-cutover soak window ends in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "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.", - "example": true + "example": true, + "default": 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.", - "example": false + "example": false, + "default": false }, "paused": { "type": "boolean", "description": "Whether the migration is paused.", - "example": false + "example": false, + "default": false } }, "required": [ @@ -151359,27 +153908,32 @@ "$id": { "type": "string", "description": "Dedicated database ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Database creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Database update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "projectId": { "type": "string", "description": "Project ID that owns this database.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "Database display name.", - "example": "My Production Database" + "example": "My Production Database", + "default": "" }, "api": { "type": "string", @@ -151396,22 +153950,26 @@ "version": { "type": "string", "description": "Database engine version.", - "example": "16" + "example": "16", + "default": "" }, "specification": { "type": "string", "description": "Specification identifier.", - "example": "s-2vcpu-2gb" + "example": "s-2vcpu-2gb", + "default": "" }, "backend": { "type": "string", "description": "Database backend provider. Possible values: edge.", - "example": "edge" + "example": "edge", + "default": "" }, "hostname": { "type": "string", "description": "Database hostname for connections.", - "example": "db-myproject-mydb.fra.appwrite.center" + "example": "db-myproject-mydb.fra.appwrite.center", + "default": "" }, "connectionPort": { "type": "integer", @@ -151423,12 +153981,14 @@ "connectionUser": { "type": "string", "description": "Database username for connections.", - "example": "appwrite_user" + "example": "appwrite_user", + "default": "" }, "connectionPassword": { "type": "string", "description": "Database password for connections.", - "example": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022" + "example": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022", + "default": "" }, "credentialGeneration": { "type": "integer", @@ -151440,22 +154000,26 @@ "connectionString": { "type": "string", "description": "Full database connection string (URI format).", - "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", + "default": "" }, "ssl": { "type": "boolean", "description": "Whether SSL\/TLS is required for client connections.", - "example": true + "example": true, + "default": false }, "status": { "type": "string", "description": "Database status. Possible values: provisioning, ready, inactive, paused, failed, deleted, restoring, scaling.", - "example": "ready" + "example": "ready", + "default": "provisioning" }, "containerStatus": { "type": "string", "description": "Container status for lifecycle-managed database runtimes: active, inactive, or failed (a wake was declined because the backing namespace is gone).", - "example": "active" + "example": "active", + "default": "" }, "lastAccessedAt": { "type": "string", @@ -151472,42 +154036,49 @@ "lifecycleState": { "type": "string", "description": "Idle-lifecycle state of the database. Possible values: active, warm, cold, hibernated.", - "example": "active" + "example": "active", + "default": "" }, "idleTimeoutMinutes": { "type": "integer", "description": "Minutes of inactivity before container scales to zero.", "format": "int32", - "example": 15 + "example": 15, + "default": 15 }, "cpu": { "type": "integer", "description": "CPU allocated in millicores.", "format": "int32", - "example": 2000 + "example": 2000, + "default": 500 }, "memory": { "type": "integer", "description": "Memory allocated in MB.", "format": "int32", - "example": 4096 + "example": 4096, + "default": 512 }, "storage": { "type": "integer", "description": "Storage allocated in GB.", "format": "int32", - "example": 100 + "example": 100, + "default": 10 }, "storageStatus": { "type": "string", "description": "Storage resize status. Possible values: idle (no resize in flight), resizing (the volume is growing towards storageTargetGb).", - "example": "resizing" + "example": "resizing", + "default": "idle" }, "storageTargetGb": { "type": "integer", "description": "Size in GB the volume is growing towards while storageStatus is resizing. 0 when no resize is in flight.", "format": "int32", - "example": 120 + "example": 120, + "default": 0 }, "storageResizeStartedAt": { "type": "string", @@ -151518,41 +154089,48 @@ "storageClass": { "type": "string", "description": "Storage class. Currently always 'ssd'; DigitalOcean exposes a single block-storage class.", - "example": "ssd" + "example": "ssd", + "default": "ssd" }, "storageMaxGb": { "type": "integer", "description": "Maximum storage allowed in GB. 0 means use system default.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "nodePool": { "type": "string", "description": "Kubernetes node pool where the database is scheduled.", - "example": "db-pool-4vcpu-8gb" + "example": "db-pool-4vcpu-8gb", + "default": "" }, "replicas": { "type": "integer", "description": "Number of high availability replicas. High availability is enabled when greater than 0.", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "syncMode": { "type": "string", "description": "Replication sync mode: async, sync, or quorum.", - "example": "async" + "example": "async", + "default": "" }, "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.", "format": "int32", - "example": 500 + "example": 500, + "default": 100 }, "networkIdleTimeoutSeconds": { "type": "integer", "description": "Connection idle timeout in seconds.", "format": "int32", - "example": 900 + "example": 900, + "default": 900 }, "networkIPAllowlist": { "type": "array", @@ -151563,61 +154141,72 @@ "example": [ "10.0.0.0\/8", "192.168.1.0\/24" - ] + ], + "default": [] }, "backupEnabled": { "type": "boolean", "description": "Whether automatic backups are enabled.", - "example": true + "example": true, + "default": true }, "pitr": { "type": "boolean", "description": "Whether point-in-time recovery is enabled.", - "example": true + "example": true, + "default": true }, "pitrRetentionDays": { "type": "integer", "description": "Number of days to retain PITR data.", "format": "int32", - "example": 14 + "example": 14, + "default": 7 }, "storageAutoscaling": { "type": "boolean", "description": "Whether automatic storage expansion is enabled.", - "example": true + "example": true, + "default": true }, "storageAutoscalingThresholdPercent": { "type": "integer", "description": "Storage usage percentage that triggers automatic expansion.", "format": "int32", - "example": 85 + "example": 85, + "default": 85 }, "storageAutoscalingMaxGb": { "type": "integer", "description": "Maximum storage size in GB for autoscaling. Defaults to 3 times the specification's storage. 0 means no limit.", "format": "int32", - "example": 30 + "example": 30, + "default": 0 }, "maintenanceWindowDay": { "type": "string", "description": "Day of the week for the maintenance window. Possible values: sun, mon, tue, wed, thu, fri, sat.", - "example": "sun" + "example": "sun", + "default": "sun" }, "maintenanceWindowHourUtc": { "type": "integer", "description": "Hour in UTC (0-23) when the maintenance window starts.", "format": "int32", - "example": 3 + "example": 3, + "default": 3 }, "metricsEnabled": { "type": "boolean", "description": "Whether metrics collection is enabled.", - "example": false + "example": false, + "default": false }, "sqlApiEnabled": { "type": "boolean", "description": "Whether the SQL API sidecar is enabled for this database.", - "example": true + "example": true, + "default": true }, "sqlApiAllowedStatements": { "type": "array", @@ -151627,30 +154216,40 @@ }, "example": [ "SELECT" + ], + "default": [ + "SELECT", + "INSERT", + "UPDATE", + "DELETE" ] }, "sqlApiMaxRows": { "type": "integer", "description": "Maximum rows returned per SQL API execution. Results larger than this are truncated.", "format": "int32", - "example": 10000 + "example": 10000, + "default": 10000 }, "sqlApiMaxBytes": { "type": "integer", "description": "Maximum serialised SQL API result payload in bytes. Results larger than this are truncated.", "format": "int32", - "example": 10485760 + "example": 10485760, + "default": 10485760 }, "sqlApiTimeoutSeconds": { "type": "integer", "description": "Maximum server-side SQL API execution time in seconds before the query is cancelled.", "format": "int32", - "example": 30 + "example": 30, + "default": 30 }, "error": { "type": "string", "description": "Error message if status is failed.", - "example": "" + "example": "", + "default": "" } }, "required": [ @@ -151773,13 +154372,15 @@ "id": 1, "name": "example" } - ] + ], + "default": [] }, "rowCount": { "type": "integer", "description": "Number of rows returned (for SELECT) or affected (for INSERT\/UPDATE\/DELETE).", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "columns": { "type": "array", @@ -151793,18 +154394,21 @@ "type": "integer", "description": "Server-side execution time in milliseconds.", "format": "int32", - "example": 12 + "example": 12, + "default": 0 }, "truncated": { "type": "boolean", "description": "True when the configured row or byte cap was hit and the result was truncated.", - "example": false + "example": false, + "default": false }, "bytes": { "type": "integer", "description": "Serialised payload size in bytes.", "format": "int32", - "example": 1024 + "example": 1024, + "default": 0 } }, "required": [ @@ -151836,12 +154440,14 @@ "name": { "type": "string", "description": "Column name as returned by the database.", - "example": "id" + "example": "id", + "default": "" }, "type": { "type": "string", "description": "Engine-specific column type (e.g. int4, text, timestamptz).", - "example": "int4" + "example": "int4", + "default": "" } }, "required": [ @@ -151860,17 +154466,20 @@ "$id": { "type": "string", "description": "Restoration ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Restoration creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "databaseId": { "type": "string", "description": "Database ID being restored into.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "sourceDatabaseId": { "type": "string", @@ -151881,7 +154490,8 @@ "projectId": { "type": "string", "description": "Project ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "backupId": { "type": "string", @@ -151892,12 +154502,14 @@ "type": { "type": "string", "description": "Restoration type. Possible values: backup (restore from a specific backup snapshot), pitr (point-in-time recovery to a specific timestamp).", - "example": "backup" + "example": "backup", + "default": "backup" }, "status": { "type": "string", "description": "Restoration status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error).", - "example": "completed" + "example": "completed", + "default": "pending" }, "targetTime": { "type": "string", @@ -151920,7 +154532,8 @@ "error": { "type": "string", "description": "Error message if restoration failed.", - "example": "" + "example": "", + "default": "" } }, "required": [ @@ -151954,28 +154567,33 @@ "health": { "type": "string", "description": "Overall health status: healthy, degraded, unhealthy, or unknown when nothing could be measured.", - "example": "healthy" + "example": "healthy", + "default": "unknown" }, "ready": { "type": "boolean", "description": "Whether the database is ready to accept connections.", - "example": true + "example": true, + "default": false }, "engine": { "type": "string", "description": "Database engine: postgresql, mysql, or mongodb.", - "example": "postgresql" + "example": "postgresql", + "default": "postgresql" }, "version": { "type": "string", "description": "Database engine version.", - "example": "17" + "example": "17", + "default": "" }, "uptime": { "type": "integer", "description": "Database uptime in seconds.", "format": "int32", - "example": 86400 + "example": 86400, + "default": 0 }, "connections": { "type": "object", @@ -151994,7 +154612,8 @@ "syncMode": { "type": "string", "description": "Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.", - "example": "async" + "example": "async", + "default": "async" }, "effectiveSyncMode": { "type": "string", @@ -152005,19 +154624,22 @@ "syncDegraded": { "type": "boolean", "description": "Whether the enforced replication is weaker than the requested syncMode.", - "example": false + "example": false, + "default": false }, "syncAcknowledgements": { "type": "integer", "description": "Number of standby acknowledgements the primary waits for before a write is committed.", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "syncStandbyCount": { "type": "integer", "description": "Number of standbys registered with the primary for synchronous replication.", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "syncStateConfirmed": { "type": "boolean", @@ -152128,66 +154750,78 @@ "$id": { "type": "string", "description": "DNS Record ID.", - "example": "5f40a6e10c65e" + "example": "5f40a6e10c65e", + "default": "" }, "$createdAt": { "type": "string", "description": "DNS Record creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "DNS Record update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "type": { "type": "string", "description": "DNS record type (e.g. A, CNAME, MX).", - "example": "A" + "example": "A", + "default": "" }, "name": { "type": "string", "description": "Record name or subdomain.", - "example": "mail" + "example": "mail", + "default": "" }, "value": { "type": "string", "description": "Value of the record (IP address, domain, etc.).", - "example": "192.0.2.1" + "example": "192.0.2.1", + "default": "" }, "ttl": { "type": "integer", "description": "Time to live (in seconds).", "format": "int32", - "example": 86400 + "example": 86400, + "default": 3600 }, "priority": { "type": "integer", "description": "Record priority (commonly used for MX).", "format": "int32", - "example": 10 + "example": 10, + "default": 0 }, "lock": { "type": "boolean", "description": "Whether this record is locked (read-only).", - "example": false + "example": false, + "default": false }, "weight": { "type": "integer", "description": "Record weight (used for SRV records).", "format": "int32", - "example": 10 + "example": 10, + "default": 0 }, "port": { "type": "integer", "description": "Target port (used for SRV records).", "format": "int32", - "example": 443 + "example": 443, + "default": 0 }, "comment": { "type": "string", "description": "Comment for the DNS record.", - "example": "Mail server record" + "example": "Mail server record", + "default": "" } }, "required": [ @@ -152226,53 +154860,63 @@ "$id": { "type": "string", "description": "Domain ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Domain creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Domain update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "domain": { "type": "string", "description": "Domain name.", - "example": "example.com" + "example": "example.com", + "default": "" }, "registrar": { "type": "string", "description": "Domain registrar (e.g. \"appwrite\" or \"third_party\").", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "nameservers": { "type": "string", "description": "Nameservers setting. \"Appwrite\" or empty string.", - "example": "Appwrite" + "example": "Appwrite", + "default": "" }, "expire": { "type": "string", "description": "Domain expiry date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "renewal": { "type": "string", "description": "Domain renewal date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "autoRenewal": { "type": "boolean", "description": "If set to true, the domain will automatically renew.", - "example": true + "example": true, + "default": false }, "renewalPrice": { "type": "integer", "description": "Renewal price (in cents).", "format": "int32", - "example": 2599 + "example": 2599, + "default": 0 }, "transferStatus": { "description": "Transfer status for domains being transferred in. Null when the domain is not being transferred.", @@ -152342,7 +154986,8 @@ "teamId": { "type": "string", "description": "Team ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "dnsRecords": { "type": "array", @@ -152390,17 +155035,20 @@ "domain": { "type": "string", "description": "Domain name.", - "example": "example.com" + "example": "example.com", + "default": "" }, "tld": { "type": "string", "description": "Top-level domain for the requested domain.", - "example": "com" + "example": "com", + "default": "" }, "available": { "type": "boolean", "description": "Whether the domain is currently available for registration.", - "example": true + "example": true, + "default": false }, "price": { "type": "number", @@ -152413,12 +155061,14 @@ "type": "integer", "description": "Price period in years.", "format": "int32", - "example": 1 + "example": 1, + "default": 1 }, "premium": { "type": "boolean", "description": "Whether the domain is a premium domain.", - "example": false + "example": false, + "default": false }, "renewalPrice": { "type": "number", @@ -152431,7 +155081,8 @@ "type": "integer", "description": "Renewal price period in years.", "format": "int32", - "example": 1 + "example": 1, + "default": 1 } }, "required": [ @@ -152460,32 +155111,38 @@ "$id": { "type": "string", "description": "Purchase\/invoice ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Purchase creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Purchase update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "domainId": { "type": "string", "description": "Domain document ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "domain": { "type": "string", "description": "Domain name.", - "example": "example.com" + "example": "example.com", + "default": "" }, "organizationId": { "type": "string", "description": "Team ID that owns the domain.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "status": { "description": "Domain purchase status.", @@ -152521,23 +155178,27 @@ ], "title": "cancelled" } - ] + ], + "default": "pending" }, "clientSecret": { "type": "string", "description": "Stripe client secret for 3DS; empty when not applicable.", - "example": "" + "example": "", + "default": "" }, "amount": { "type": "number", "description": "Purchase amount.", "format": "double", - "example": 25.99 + "example": 25.99, + "default": 0 }, "currency": { "type": "string", "description": "Currency code.", - "example": "USD" + "example": "USD", + "default": "USD" } }, "required": [ @@ -152572,12 +155233,14 @@ "domain": { "type": "string", "description": "Domain suggestion.", - "example": "example.com" + "example": "example.com", + "default": "" }, "premium": { "type": "boolean", "description": "Is the domain premium?", - "example": true + "example": true, + "default": false }, "price": { "type": "number", @@ -152589,7 +155252,8 @@ "available": { "type": "boolean", "description": "Is the domain available?", - "example": true + "example": true, + "default": false } }, "required": [ @@ -152611,7 +155275,8 @@ "authCode": { "type": "string", "description": "Domain transfer authorization code.", - "example": "mock_1a2b3c4d" + "example": "mock_1a2b3c4d", + "default": "" } }, "required": [ @@ -152687,17 +155352,20 @@ ], "title": "service_unavailable" } - ] + ], + "default": "pending_registry" }, "reason": { "type": "string", "description": "Additional transfer status information.", - "example": "Transfer in progress" + "example": "Transfer in progress", + "default": "" }, "timestamp": { "type": "string", "description": "Transfer status timestamp in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -152718,52 +155386,62 @@ "$id": { "type": "string", "description": "Feedback ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Feedback creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Feedback update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "title": { "type": "string", "description": "Feedback reason", - "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", + "default": "" }, "message": { "type": "string", "description": "Feedback message", - "example": "The platform experienced significant downtime which affected my users." + "example": "The platform experienced significant downtime which affected my users.", + "default": "" }, "fromPlanId": { "type": "string", "description": "Plan ID downgrading from", - "example": "pro" + "example": "pro", + "default": "" }, "toPlanId": { "type": "string", "description": "Plan ID downgrading to", - "example": "free" + "example": "free", + "default": "" }, "teamId": { "type": "string", "description": "Organization ID", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "userId": { "type": "string", "description": "User ID who submitted feedback", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "version": { "type": "string", "description": "Console version", - "example": "1.8.0" + "example": "1.8.0", + "default": "" } }, "required": [ @@ -152799,13 +155477,15 @@ "type": "number", "description": "Total amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 }, "grossAmount": { "type": "number", "description": "Gross payable amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 }, "discount": { "type": "number", @@ -152818,7 +155498,8 @@ "type": "number", "description": "Credits amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 }, "items": { "type": "array", @@ -152840,7 +155521,8 @@ "type": "integer", "description": "Trial days", "format": "int32", - "example": 14 + "example": 14, + "default": 0 }, "trialEndDate": { "type": "string", @@ -152895,13 +155577,15 @@ "label": { "type": "string", "description": "Label", - "example": "Plan name" + "example": "Plan name", + "default": "" }, "value": { "type": "number", "description": "Gross payable amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 } }, "required": [ @@ -152920,17 +155604,20 @@ "currentBillingPlanId": { "type": "string", "description": "Current billing plan ID", - "example": "tier-2" + "example": "tier-2", + "default": "" }, "targetBillingPlanId": { "type": "string", "description": "Target billing plan ID", - "example": "tier-0" + "example": "tier-0", + "default": "" }, "direction": { "type": "string", "description": "Direction of plan change: upgrade, downgrade, or same", - "example": "downgrade" + "example": "downgrade", + "default": "" }, "estimation": { "type": "object", @@ -152974,13 +155661,15 @@ "type": "number", "description": "Total amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 }, "grossAmount": { "type": "number", "description": "Gross payable amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 }, "discount": { "type": "number", @@ -152993,7 +155682,8 @@ "type": "number", "description": "Credits amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 }, "items": { "type": "array", @@ -153015,7 +155705,8 @@ "type": "integer", "description": "Trial days", "format": "int32", - "example": 14 + "example": 14, + "default": 0 }, "trialEndDate": { "type": "string", @@ -153027,7 +155718,8 @@ "type": "number", "description": "Organization's existing credits", "format": "double", - "example": 0 + "example": 0, + "default": 0 } }, "required": [ @@ -153058,17 +155750,20 @@ "type": { "type": "string", "description": "Conversation type.", - "example": "support" + "example": "support", + "default": "" }, "email": { "type": "string", "description": "Email address the conversation was filed under. For a signed in console user this is the account email.", - "example": "john@appwrite.io" + "example": "john@appwrite.io", + "default": "" }, "organizationId": { "type": "string", "description": "Organization ID the conversation was filed against. Empty when none was given or the user is not a member.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" } }, "required": [ @@ -153095,7 +155790,8 @@ "example": [ "pgvector", "uuid-ossp" - ] + ], + "default": [] }, "available": { "type": "array", @@ -153106,7 +155802,8 @@ "example": [ "postgis", "pg_trgm" - ] + ], + "default": [] }, "metadata": { "type": "array", @@ -153141,17 +155838,20 @@ "$id": { "type": "string", "description": "Member identifier.", - "example": "1" + "example": "1", + "default": "" }, "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).", - "example": "replica" + "example": "replica", + "default": "unknown" }, "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.", - "example": "active" + "example": "active", + "default": "" }, "replicating": { "type": "boolean", @@ -153187,33 +155887,39 @@ "$id": { "type": "string", "description": "Operation ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Operation creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "databaseId": { "type": "string", "description": "Database ID the operation ran against.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "type": { "type": "string", "description": "Operation type, such as provision, update, credentials-update, restore, pausing, resuming, failover, backup-create or cross-region-enable.", - "example": "update" + "example": "update", + "default": "" }, "status": { "type": "string", "description": "Operation status. Possible values: queued (accepted and waiting to resume), running (in progress), completed (finished successfully), failed (ended in an error).", - "example": "completed" + "example": "completed", + "default": "" }, "attempts": { "type": "integer", "description": "Number of times this operation has been attempted.", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "requestedAt": { "type": "string", @@ -153236,12 +155942,14 @@ "errorCode": { "type": "string", "description": "Machine-readable failure code. `Interrupted` marks an attempt that ended before its outcome could be confirmed.", - "example": "Interrupted" + "example": "Interrupted", + "default": "" }, "errorMessage": { "type": "string", "description": "Failure message if the operation failed.", - "example": "" + "example": "", + "default": "" } }, "required": [ @@ -153276,7 +155984,8 @@ "type": "integer", "description": "Total number of operations.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "operations": { "type": "array", @@ -153304,12 +156013,14 @@ "type": "integer", "description": "Number of configured replicas. Zero means high availability is disabled.", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "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.", - "example": "async" + "example": "async", + "default": "async" }, "effectiveSyncMode": { "type": "string", @@ -153320,19 +156031,22 @@ "syncDegraded": { "type": "boolean", "description": "Whether the enforced replication is weaker than the requested syncMode.", - "example": false + "example": false, + "default": false }, "syncAcknowledgements": { "type": "integer", "description": "Number of standby acknowledgements the primary waits for before a write is committed. Zero means writes are acknowledged locally.", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "syncStandbyCount": { "type": "integer", "description": "Number of standbys registered with the primary for synchronous replication.", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "syncStateConfirmed": { "type": "boolean", @@ -153375,22 +156089,26 @@ "domain": { "type": "string", "description": "Domain name.", - "example": "appwrite.company.com" + "example": "appwrite.company.com", + "default": "" }, "type": { "type": "string", "description": "Invalidation type. Possible values are \"tag\", \"path\", or \"all\".", - "example": "tag" + "example": "tag", + "default": "" }, "reference": { "type": "string", "description": "Invalidated reference. Depending on type this is a cache tag name, a URL path, or empty when type is all.", - "example": "products" + "example": "products", + "default": "" }, "status": { "type": "string", "description": "Invalidation status.", - "example": "success" + "example": "success", + "default": "" } }, "required": [ @@ -153413,17 +156131,20 @@ "$id": { "type": "string", "description": "Invoice ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Invoice creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Invoice update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -153433,22 +156154,26 @@ }, "example": [ "read(\"any\")" - ] + ], + "default": [] }, "teamId": { "type": "string", "description": "Project ID", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "aggregationId": { "type": "string", "description": "Aggregation ID", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "plan": { "type": "string", "description": "Billing plan selected. Can be one of `tier-0`, `tier-1` or `tier-2`.", - "example": "tier-1" + "example": "tier-1", + "default": "tier-0" }, "usage": { "type": "array", @@ -153462,48 +156187,56 @@ "type": "number", "description": "Invoice Amount", "format": "double", - "example": 50 + "example": 50, + "default": 0 }, "tax": { "type": "number", "description": "Tax percentage", "format": "double", - "example": 17 + "example": 17, + "default": 0 }, "taxAmount": { "type": "number", "description": "Tax amount", "format": "double", - "example": 12.5 + "example": 12.5, + "default": 0 }, "vat": { "type": "number", "description": "VAT percentage", "format": "double", - "example": 17 + "example": 17, + "default": 0 }, "vatAmount": { "type": "number", "description": "VAT amount", "format": "double", - "example": 12.5 + "example": 12.5, + "default": 0 }, "grossAmount": { "type": "number", "description": "Gross amount after vat, tax, and discounts applied.", "format": "double", - "example": 12.5 + "example": 12.5, + "default": 0 }, "creditsUsed": { "type": "number", "description": "Credits used.", "format": "double", - "example": 30 + "example": 30, + "default": 0 }, "currency": { "type": "string", "description": "Currency the invoice is in", - "example": "USD" + "example": "USD", + "default": "USD" }, "clientSecret": { "type": "string", @@ -153514,12 +156247,14 @@ "status": { "type": "string", "description": "Invoice status", - "example": "succeeded" + "example": "succeeded", + "default": "" }, "type": { "type": "string", "description": "Invoice type. Can be one of `subscription`, `domain_purchase`, `domain_renewal`, `domain_transfer`, or `addon_*`.", - "example": "subscription" + "example": "subscription", + "default": "subscription" }, "lastError": { "type": "string", @@ -153535,12 +156270,14 @@ "from": { "type": "string", "description": "Beginning date of the invoice", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "to": { "type": "string", "description": "End date of the invoice", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -153601,22 +156338,26 @@ "$createdAt": { "type": "string", "description": "Block creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type that is blocked", - "example": "project" + "example": "project", + "default": "" }, "resourceId": { "type": "string", "description": "Resource identifier that is blocked", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "mode": { "type": "string", "description": "Block mode. full blocks reads and writes; readOnly blocks writes only.", - "example": "readOnly" + "example": "readOnly", + "default": "full" }, "expiredAt": { "type": "string", @@ -153633,27 +156374,32 @@ "projectName": { "type": "string", "description": "Name of the project this block applies to.", - "example": "My Project" + "example": "My Project", + "default": "" }, "region": { "type": "string", "description": "Region of the project this block applies to.", - "example": "fra" + "example": "fra", + "default": "" }, "organizationName": { "type": "string", "description": "Name of the organization that owns the project.", - "example": "Acme Inc." + "example": "Acme Inc.", + "default": "" }, "organizationId": { "type": "string", "description": "ID of the organization that owns the project.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "billingPlan": { "type": "string", "description": "Billing plan of the organization that owns the project.", - "example": "pro" + "example": "pro", + "default": "" } }, "required": [ @@ -153689,7 +156435,8 @@ "type": "integer", "description": "Number of blocks deleted", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "blocks": { "type": "array", @@ -153709,6 +156456,187 @@ "blocks": [] } }, + "threat": { + "description": "Threat", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Threat ID.", + "example": "5e5ea5c16897e", + "default": "" + }, + "$createdAt": { + "type": "string", + "description": "Threat creation date in ISO 8601 format.", + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" + }, + "$updatedAt": { + "type": "string", + "description": "Threat update date in ISO 8601 format.", + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" + }, + "projectId": { + "type": "string", + "description": "ID of the project the resource belongs to.", + "example": "5e5ea5c16897e", + "default": "" + }, + "teamId": { + "type": "string", + "description": "ID of the organization that owns the project.", + "example": "5e5ea5c16897e", + "default": "" + }, + "userId": { + "type": "string", + "description": "ID of the user the threat is attributed to. Not set yet.", + "example": "", + "default": "" + }, + "region": { + "type": "string", + "description": "Region of the project.", + "example": "fra", + "default": "" + }, + "resourceType": { + "type": "string", + "description": "Type of the flagged resource.", + "example": "deployments", + "default": "" + }, + "resourceId": { + "type": "string", + "description": "ID of the flagged resource.", + "example": "5e5ea5c16897e", + "default": "" + }, + "resourceCreatedAt": { + "type": "string", + "description": "Creation date of the flagged resource in ISO 8601 format. Empty for a manual threat, which names the resource without looking it up.", + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" + }, + "type": { + "type": "string", + "description": "How the threat was found. Possible values are `hash` (a file matched a known-bad signature), `analysis` (source analysis flagged a deployment), `scan` (the URL scanner flagged a hostname) or `manual` (recorded by an operator through the admin API).", + "example": "scan", + "default": "" + }, + "status": { + "type": "string", + "description": "Triage status. Possible values are `open`, `resolved` or `dismissed`.", + "example": "open", + "default": "open" + }, + "description": { + "type": "string", + "description": "What was found: the detector's summary, or the operator's words for a manual threat.", + "example": "Phishing page impersonating a bank login", + "default": "" + }, + "createdBy": { + "type": "string", + "description": "ID of the console user who recorded the threat. Empty when a detector did.", + "example": "5e5ea5c16897e", + "default": "" + }, + "hashSignature": { + "type": "string", + "description": "The signature that matched. Used if type is `hash`.", + "example": "", + "default": "" + }, + "analysisVerdict": { + "type": "string", + "description": "The analyser's classification of the finding, in snake case. Used if type is `analysis`.", + "example": "", + "default": "" + }, + "analysisFiles": { + "type": "array", + "description": "Paths of the files the finding is in. Used if type is `analysis`.", + "items": { + "type": "string" + }, + "example": [], + "default": [] + }, + "scanDomain": { + "type": "string", + "description": "Hostname the URL scanner flagged. Used if type is `scan`.", + "example": "example.com", + "default": "" + }, + "scanVerdict": { + "type": "string", + "description": "The URL scanner's verdict. Possible values are `malicious` or `phishing`. Used if type is `scan`.", + "example": "phishing", + "default": "" + }, + "scanSeverity": { + "type": "string", + "description": "The URL scanner's severity. Possible values are `high` or `medium`. Used if type is `scan`.", + "example": "high", + "default": "" + }, + "scanReportId": { + "type": "string", + "description": "ID of the URL scanner's report. Used if type is `scan`.", + "example": "", + "default": "" + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "projectId", + "teamId", + "userId", + "region", + "resourceType", + "resourceId", + "resourceCreatedAt", + "type", + "status", + "description", + "createdBy", + "hashSignature", + "analysisVerdict", + "analysisFiles", + "scanDomain", + "scanVerdict", + "scanSeverity", + "scanReportId" + ], + "example": { + "$id": "5e5ea5c16897e", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "projectId": "5e5ea5c16897e", + "teamId": "5e5ea5c16897e", + "userId": "", + "region": "fra", + "resourceType": "deployments", + "resourceId": "5e5ea5c16897e", + "resourceCreatedAt": "2020-10-15T06:38:00.000+00:00", + "type": "scan", + "status": "open", + "description": "Phishing page impersonating a bank login", + "createdBy": "5e5ea5c16897e", + "hashSignature": "", + "analysisVerdict": "", + "analysisFiles": [], + "scanDomain": "example.com", + "scanVerdict": "phishing", + "scanSeverity": "high", + "scanReportId": "" + } + }, "managerDatabase": { "description": "ManagerDatabase", "type": "object", @@ -153716,32 +156644,38 @@ "$id": { "type": "string", "description": "Database ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "projectId": { "type": "string", "description": "Project ID that owns this database.", - "example": "project-abc123" + "example": "project-abc123", + "default": "" }, "projectInternalId": { "type": "string", "description": "Internal (sequence) ID of the owning project generation. The Edge namespace reaper compares this against the labelled namespace generation before tearing down an orphan, so it must always be a non-empty string for a live database.", - "example": "42" + "example": "42", + "default": "" }, "databaseInternalId": { "type": "string", "description": "Internal (sequence) ID of this database generation. The Edge namespace reaper compares this against the labelled namespace generation before tearing down an orphan, so it must always be a non-empty string for a live database.", - "example": "7" + "example": "7", + "default": "" }, "database": { "type": "string", "description": "Physical database\/catalog name. Defaults to the database ID.", - "example": "mydb" + "example": "mydb", + "default": "" }, "hostname": { "type": "string", "description": "Database hostname for connections.", - "example": "db-myproject-mydb.fra.appwrite.center" + "example": "db-myproject-mydb.fra.appwrite.center", + "default": "" }, "port": { "type": "integer", @@ -153753,57 +156687,68 @@ "engine": { "type": "string", "description": "Database engine: postgresql, mysql, or mongodb.", - "example": "postgresql" + "example": "postgresql", + "default": "postgresql" }, "status": { "type": "string", "description": "Database status: provisioning, ready, inactive, paused, failed, deleting, deleted, restoring, scaling, upgrading, migrating.", - "example": "ready" + "example": "ready", + "default": "provisioning" }, "containerStatus": { "type": "string", "description": "Container status for lifecycle-managed database runtimes: active, inactive, or failed (a wake was declined because the backing namespace is gone).", - "example": "active" + "example": "active", + "default": "" }, "lastErrorCode": { "type": "string", "description": "Code of the last failure recorded against this database. The Edge proxy reads it to refuse immediately instead of spending its cold-start budget on a wake that cannot succeed: dedicated_database_abandoned means a wake was already declined because the backing namespace is gone. Empty when no error is recorded.", - "example": "dedicated_database_abandoned" + "example": "dedicated_database_abandoned", + "default": "" }, "lifecycleState": { "type": "string", "description": "Idle-lifecycle state at fetch time: active, warm, cold, or hibernated. The Edge proxy labels wake telemetry with it so warm-start, cold-start, and hibernate-resume durations chart separately.", - "example": "warm" + "example": "warm", + "default": "" }, "suspended": { "type": "boolean", "description": "Whether access to this database is suspended because the owning project is blocked, the organization is read-only (e.g. payment issue), or the plan no longer permits it. When true, the Edge proxy refuses new connections and never cold-starts the database. Recovers automatically once the underlying condition clears.", - "example": false + "example": false, + "default": false }, "suspendedReason": { "type": "string", "description": "Reason access is suspended: blocked, readonly, or plan. Empty when not suspended.", - "example": "readonly" + "example": "readonly", + "default": "" }, "type": { "type": "string", "description": "Database type: shared (scale-to-zero pod) or dedicated (StatefulSet).", - "example": "dedicated" + "example": "dedicated", + "default": "shared" }, "region": { "type": "string", "description": "Region identifier (e.g., fra, nyc, syd).", - "example": "fra" + "example": "fra", + "default": "" }, "backend": { "type": "string", "description": "Database backend provider: edge.", - "example": "edge" + "example": "edge", + "default": "edge" }, "sqlApiEnabled": { "type": "boolean", "description": "Whether the SQL API is enabled for this database.", - "example": true + "example": true, + "default": true }, "sqlApiAllowedStatements": { "type": "array", @@ -153813,25 +156758,34 @@ }, "example": [ "SELECT" + ], + "default": [ + "SELECT", + "INSERT", + "UPDATE", + "DELETE" ] }, "sqlApiMaxRows": { "type": "integer", "description": "Maximum rows returned per SQL API execution. Results larger than this are truncated.", "format": "int32", - "example": 10000 + "example": 10000, + "default": 10000 }, "sqlApiMaxBytes": { "type": "integer", "description": "Maximum serialised SQL API result payload in bytes. Results larger than this are truncated.", "format": "int32", - "example": 10485760 + "example": 10485760, + "default": 10485760 }, "sqlApiTimeoutSeconds": { "type": "integer", "description": "Maximum server-side SQL API execution time in seconds before the query is cancelled.", "format": "int32", - "example": 30 + "example": 30, + "default": 30 } }, "required": [ @@ -153889,53 +156843,63 @@ "$id": { "type": "string", "description": "Domain ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Domain creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Domain update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "domain": { "type": "string", "description": "Domain name.", - "example": "example.com" + "example": "example.com", + "default": "" }, "registrar": { "type": "string", "description": "Domain registrar (e.g. \"appwrite\" or \"third_party\").", - "example": "appwrite" + "example": "appwrite", + "default": "" }, "nameservers": { "type": "string", "description": "Nameservers setting. \"Appwrite\" or empty string.", - "example": "Appwrite" + "example": "Appwrite", + "default": "" }, "expire": { "type": "string", "description": "Domain expiry date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "renewal": { "type": "string", "description": "Domain renewal date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "autoRenewal": { "type": "boolean", "description": "If set to true, the domain will automatically renew.", - "example": true + "example": true, + "default": false }, "renewalPrice": { "type": "integer", "description": "Renewal price (in cents).", "format": "int32", - "example": 2599 + "example": 2599, + "default": 0 }, "transferStatus": { "description": "Transfer status for domains being transferred in. Null when the domain is not being transferred.", @@ -154005,7 +156969,8 @@ "teamId": { "type": "string", "description": "Team ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "dnsRecords": { "type": "array", @@ -154019,7 +156984,8 @@ "type": "integer", "description": "SOA serial number", "format": "int32", - "example": 12 + "example": 12, + "default": 0 } }, "required": [ @@ -154061,7 +157027,8 @@ "projectId": { "type": "string", "description": "Project ID that owns this API key.", - "example": "project-abc123" + "example": "project-abc123", + "default": "" }, "scopes": { "type": "array", @@ -154071,7 +157038,8 @@ }, "example": [ "databases.write" - ] + ], + "default": [] } }, "required": [ @@ -154090,7 +157058,8 @@ "userId": { "type": "string", "description": "ID of the user the JWT resolves to within the project.", - "example": "user-abc123" + "example": "user-abc123", + "default": "" } }, "required": [ @@ -154107,47 +157076,56 @@ "$id": { "type": "string", "description": "Rule ID.", - "example": "wafRule1" + "example": "wafRule1", + "default": "" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Human friendly rule name.", - "example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic", + "default": "" }, "description": { "type": "string", "description": "Optional description for the rule.", - "example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql", + "default": "" }, "teamId": { "type": "string", "description": "Team ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "projectId": { "type": "string", "description": "Project ID.", - "example": "cloudConsole" + "example": "cloudConsole", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "example": "functions" + "example": "functions", + "default": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "example": "functionId" + "example": "functionId", + "default": "" }, "action": { "description": "Action performed when the rule matches.", @@ -154196,12 +157174,14 @@ "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "example": true + "example": true, + "default": true }, "conditions": { "type": "array", @@ -154217,13 +157197,15 @@ "127.0.0.1" ] } - ] + ], + "default": [] }, "config": { "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "example": {} + "example": {}, + "default": {} }, "resourceInternalId": { "type": "integer", @@ -154282,28 +157264,33 @@ "$id": { "type": "string", "description": "Team ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Team creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Team update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Team name.", - "example": "VIP" + "example": "VIP", + "default": "" }, "total": { "type": "integer", "description": "Total number of team members.", "format": "int32", - "example": 7 + "example": 7, + "default": 0 }, "prefs": { "type": "object", @@ -154335,17 +157322,22 @@ "example": [ 50, 75 + ], + "default": [ + 75 ] }, "billingPlan": { "type": "string", "description": "Organization's billing plan ID.", - "example": "tier-1" + "example": "tier-1", + "default": "tier-0" }, "billingPlanId": { "type": "string", "description": "Organization's billing plan ID.", - "example": "tier-1" + "example": "tier-1", + "default": "tier-0" }, "billingPlanDetails": { "type": "object", @@ -154359,7 +157351,8 @@ "billingEmail": { "type": "string", "description": "Billing email set for the organization.", - "example": "billing@org.example" + "example": "billing@org.example", + "default": "" }, "billingStartDate": { "type": "string", @@ -154425,7 +157418,8 @@ "status": { "type": "string", "description": "Team status.", - "example": "active" + "example": "active", + "default": "draft" }, "remarks": { "type": "string", @@ -154487,12 +157481,14 @@ }, "markedForDeletion": { "type": "boolean", - "description": "Marked for deletion" + "description": "Marked for deletion", + "default": false }, "platform": { "type": "string", "description": "Product with which the organization is associated (appwrite or imagine)", - "example": "imagine" + "example": "imagine", + "default": "appwrite" }, "projects": { "type": "array", @@ -154500,7 +157496,8 @@ "items": { "type": "string" }, - "example": [] + "example": [], + "default": [] } }, "required": [ @@ -154571,32 +157568,38 @@ "message": { "type": "string", "description": "Message for the end user to show on Console.", - "example": "" + "example": "", + "default": "Your payment requires authentication" }, "clientSecret": { "type": "string", "description": "Stripe client secret to use for validation.", - "example": "" + "example": "", + "default": "" }, "organizationId": { "type": "string", "description": "Organization ID for which the payment authentication is needed.", - "example": "" + "example": "", + "default": "" }, "invoiceId": { "type": "string", "description": "Invoice ID against which the payment needs to be validated.", - "example": "" + "example": "", + "default": "" }, "addonId": { "type": "string", "description": "Addon ID to use when calling the addon validate endpoint. Empty when authentication is not for an addon.", - "example": "" + "example": "", + "default": "" }, "projectId": { "type": "string", "description": "Project ID for project-level addon payments. Empty for organization-level addons.", - "example": "" + "example": "", + "default": "" } }, "required": [ @@ -154623,17 +157626,20 @@ "$id": { "type": "string", "description": "Payment Method ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Payment method creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Payment method update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$permissions": { "type": "array", @@ -154643,27 +157649,32 @@ }, "example": [ "read(\"any\")" - ] + ], + "default": [] }, "providerMethodId": { "type": "string", "description": "Payment method ID from the payment provider", - "example": "abdk3ed3sdkfj" + "example": "abdk3ed3sdkfj", + "default": "" }, "clientSecret": { "type": "string", "description": "Client secret hash for payment setup", - "example": "seti_ddfe" + "example": "seti_ddfe", + "default": "" }, "providerUserId": { "type": "string", "description": "User ID from the payment provider.", - "example": "abdk3ed3sdkfj" + "example": "abdk3ed3sdkfj", + "default": "" }, "userId": { "type": "string", "description": "ID of the Team.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "expiryMonth": { "type": "integer", @@ -154724,7 +157735,8 @@ "default": { "type": "boolean", "description": "True when it's the default payment method.", - "example": false + "example": false, + "default": false }, "expired": { "type": "boolean", @@ -154782,12 +157794,14 @@ "earliest": { "type": "string", "description": "Earliest available recovery point.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "latest": { "type": "string", "description": "Latest available recovery point.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -154806,42 +157820,49 @@ "currency": { "type": "string", "description": "Currency code", - "example": "USD" + "example": "USD", + "default": "USD" }, "grossAmount": { "type": "number", "description": "Gross amount after all discounts and credits", "format": "double", - "example": 15 + "example": 15, + "default": 0 }, "credits": { "type": "number", "description": "Credits applied from coupon", "format": "double", - "example": 0 + "example": 0, + "default": 0 }, "organizationCredits": { "type": "number", "description": "Organization's existing credits applied", "format": "double", - "example": 5 + "example": 5, + "default": 0 }, "discount": { "type": "number", "description": "Discount amount from prorated invoices", "format": "double", - "example": 0 + "example": 0, + "default": 0 }, "amount": { "type": "number", "description": "Total amount before discounts and credits", "format": "double", - "example": 20 + "example": 20, + "default": 0 }, "nextInvoiceDate": { "type": "string", "description": "Next invoice date", - "example": "2025-12-01T00:00:00.000Z" + "example": "2025-12-01T00:00:00.000Z", + "default": "" }, "items": { "type": "array", @@ -154858,7 +157879,8 @@ "label": "Additional seats", "value": 10 } - ] + ], + "default": [] }, "discounts": { "type": "array", @@ -154871,7 +157893,8 @@ "label": "Organization credits", "value": 5 } - ] + ], + "default": [] } }, "required": [ @@ -154918,7 +157941,8 @@ "canChangePlan": { "type": "boolean", "description": "Whether the plan change is allowed", - "example": false + "example": false, + "default": true }, "unsupportedAddons": { "type": "array", @@ -154928,7 +157952,8 @@ }, "example": [ "baa" - ] + ], + "default": [] }, "projects": { "type": "object", @@ -154964,7 +157989,8 @@ "type": "integer", "description": "Number of projects exceeding target plan limits", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "projectCompliance": { "type": "array", @@ -155003,17 +158029,20 @@ "$id": { "type": "string", "description": "Project ID", - "example": "proj_a" + "example": "proj_a", + "default": "" }, "name": { "type": "string", "description": "Project name", - "example": "Marketing Site" + "example": "Marketing Site", + "default": "" }, "isCompliant": { "type": "boolean", "description": "Whether the project complies with target plan limits", - "example": false + "example": false, + "default": true }, "resources": { "type": "array", @@ -155027,6 +158056,7 @@ "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.", "example": "Failed to get project compliance from Regions API. Status: 500", + "default": "", "nullable": true } }, @@ -155051,35 +158081,41 @@ "type": { "type": "string", "description": "Resource type", - "example": "databases" + "example": "databases", + "default": "" }, "currentUsage": { "type": "integer", "description": "Current usage count", "format": "int32", - "example": 3 + "example": 3, + "default": 0 }, "limit": { "type": "integer", "description": "Allowed limit in target plan", "format": "int32", - "example": 1 + "example": 1, + "default": 0 }, "status": { "type": "string", "description": "Compliance status. Either `over_limit` or `within_limit`.", - "example": "over_limit" + "example": "over_limit", + "default": "" }, "excess": { "type": "integer", "description": "Number of resources exceeding the limit", "format": "int32", - "example": 2 + "example": 2, + "default": 0 }, "resolutionHint": { "type": "string", "description": "Suggestion for resolving the compliance issue. Empty when the resource is within limits.", - "example": "Delete or migrate 2 databases." + "example": "Delete or migrate 2 databases.", + "default": "" } }, "required": [ @@ -155106,22 +158142,26 @@ "$id": { "type": "string", "description": "Backup policy ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "name": { "type": "string", "description": "Backup policy name.", - "example": "Hourly backups" + "example": "Hourly backups", + "default": "" }, "$createdAt": { "type": "string", "description": "Policy creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Policy update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "services": { "type": "array", @@ -155147,34 +158187,40 @@ "type": "string", "description": "The resource ID to backup. Set only if this policy should backup a single resource.", "example": "DB1", + "default": "", "nullable": true }, "resourceType": { "type": "string", "description": "The resource type to backup. Set only if this policy should backup a single resource.", "example": "database", + "default": "", "nullable": true }, "retention": { "type": "integer", "description": "How many days to keep the backup before it will be automatically deleted.", "format": "int32", - "example": 7 + "example": 7, + "default": 1 }, "schedule": { "type": "string", "description": "Policy backup schedule in CRON format.", - "example": "0 * * * *" + "example": "0 * * * *", + "default": "0 * * * *" }, "type": { "type": "string", "description": "Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup).", - "example": "full" + "example": "full", + "default": "full" }, "enabled": { "type": "boolean", "description": "Is this policy enabled.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -155211,55 +158257,65 @@ "enabled": { "type": "boolean", "description": "Whether connection pooling is enabled.", - "example": true + "example": true, + "default": false }, "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).", - "example": "transaction" + "example": "transaction", + "default": "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.", "format": "int32", - "example": 200 + "example": 200, + "default": 100 }, "defaultPoolSize": { "type": "integer", "description": "Default pool size per user.", "format": "int32", - "example": 25 + "example": 25, + "default": 20 }, "port": { "type": "integer", "description": "Pooler listening port.", "format": "int32", - "example": 6432 + "example": 6432, + "default": 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.", - "example": true + "example": true, + "default": false }, "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.", - "example": "100m" + "example": "100m", + "default": "" }, "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.", - "example": "200m" + "example": "200m", + "default": "" }, "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.", - "example": "64Mi" + "example": "64Mi", + "default": "" }, "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.", - "example": "128Mi" + "example": "128Mi", + "default": "" } }, "required": [ @@ -155294,22 +158350,26 @@ "key": { "type": "string", "description": "Extension key used with CREATE EXTENSION.", - "example": "vector" + "example": "vector", + "default": "" }, "name": { "type": "string", "description": "Human-readable extension name.", - "example": "pgvector" + "example": "pgvector", + "default": "" }, "description": { "type": "string", "description": "Short description of what the extension provides.", - "example": "Vector data type and similarity search for embeddings." + "example": "Vector data type and similarity search for embeddings.", + "default": "" }, "category": { "type": "string", "description": "Category the extension belongs to.", - "example": "search" + "example": "search", + "default": "" } }, "required": [ @@ -155332,45 +158392,54 @@ "$id": { "type": "string", "description": "Program ID", - "example": "" + "example": "", + "default": "" }, "title": { "type": "string", "description": "Program title", - "example": "" + "example": "", + "default": "" }, "description": { "type": "string", "description": "Program description", - "example": "" + "example": "", + "default": "" }, "tag": { "type": "string", - "description": "Program tag for highlighting on console" + "description": "Program tag for highlighting on console", + "default": "" }, "icon": { "type": "string", - "description": "Program icon for highlighting on console" + "description": "Program icon for highlighting on console", + "default": "" }, "url": { "type": "string", "description": "URL for more information on this program", - "example": "" + "example": "", + "default": "" }, "active": { "type": "boolean", "description": "Whether this program is active", - "example": false + "example": false, + "default": true }, "external": { "type": "boolean", "description": "Whether this program is external", - "example": false + "example": false, + "default": true }, "billingPlanId": { "type": "string", "description": "Billing plan ID that this is program is associated with.", - "example": "" + "example": "", + "default": "" } }, "required": [ @@ -155403,12 +158472,14 @@ "$id": { "type": "string", "description": "Region ID", - "example": "eu-fr" + "example": "eu-fr", + "default": "" }, "name": { "type": "string", "description": "Region name", - "example": "EU (Frankfurt)" + "example": "EU (Frankfurt)", + "default": "" }, "available": { "type": "boolean", @@ -155419,17 +158490,20 @@ "disabled": { "type": "boolean", "description": "Does the backend support this region.", - "example": false + "example": false, + "default": false }, "default": { "type": "boolean", "description": "Is this the region default.", - "example": true + "example": true, + "default": false }, "flag": { "type": "string", "description": "Region flag code.", - "example": "fr" + "example": "fr", + "default": "" } }, "required": [ @@ -155455,32 +158529,38 @@ "$id": { "type": "string", "description": "Restoration ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Restoration creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Restoration update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "archiveId": { "type": "string", "description": "Backup archive ID.", - "example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7", + "default": "" }, "policyId": { "type": "string", "description": "Backup policy ID.", - "example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7", + "default": "" }, "status": { "type": "string", "description": "The status of the restoration. Possible values: pending, downloading, processing, completed, failed.", - "example": "completed" + "example": "completed", + "default": "" }, "startedAt": { "type": "string", @@ -155491,7 +158571,8 @@ "migrationId": { "type": "string", "description": "Migration ID.", - "example": "did8jx6ws45jana098ab7" + "example": "did8jx6ws45jana098ab7", + "default": "" }, "services": { "type": "array", @@ -155527,7 +158608,8 @@ } ] } - } + }, + "default": {} } }, "required": [ @@ -155574,7 +158656,8 @@ "type": "integer", "description": "Total number of restorations that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "restorations": { "type": "array", @@ -155601,22 +158684,26 @@ "name": { "type": "string", "description": "Name of user", - "example": "" + "example": "", + "default": "" }, "image": { "type": "string", "description": "Reviewer image", - "example": "" + "example": "", + "default": "" }, "description": { "type": "string", "description": "Reviewer description", - "example": "" + "example": "", + "default": "" }, "review": { "type": "string", "description": "Review", - "example": "" + "example": "", + "default": "" } }, "required": [ @@ -155644,7 +158731,8 @@ }, "example": [ "users.read" - ] + ], + "default": [] }, "roles": { "type": "array", @@ -155654,7 +158742,8 @@ }, "example": [ "developer" - ] + ], + "default": [] } }, "required": [ @@ -155673,48 +158762,57 @@ "$id": { "type": "string", "description": "Rule ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Rule creation date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Rule update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "domain": { "type": "string", "description": "Domain name.", - "example": "appwrite.company.com" + "example": "appwrite.company.com", + "default": "" }, "type": { "type": "string", "description": "Action definition for the rule. Possible values are \"api\", \"deployment\", or \"redirect\"", - "example": "deployment" + "example": "deployment", + "default": "" }, "trigger": { "type": "string", "description": "Defines how the rule was created. Possible values are \"manual\" or \"deployment\"", - "example": "manual" + "example": "manual", + "default": "" }, "redirectUrl": { "type": "string", "description": "URL to redirect to. Used if type is \"redirect\"", - "example": "https:\/\/appwrite.io\/docs" + "example": "https:\/\/appwrite.io\/docs", + "default": "" }, "redirectStatusCode": { "type": "integer", "description": "Status code to apply during redirect. Used if type is \"redirect\"", "format": "int32", - "example": 301 + "example": 301, + "default": 301 }, "deploymentId": { "type": "string", "description": "ID of deployment. Used if type is \"deployment\"", - "example": "n3u9feiwmf" + "example": "n3u9feiwmf", + "default": "" }, "deploymentResourceType": { "description": "Type of deployment resource: function, site, or dedicatedDatabase.", @@ -155748,12 +158846,14 @@ "deploymentResourceId": { "type": "string", "description": "ID of deployment's resource (site or function ID). Used if type is \"deployment\"", - "example": "n3u9feiwmf" + "example": "n3u9feiwmf", + "default": "" }, "deploymentVcsProviderBranch": { "type": "string", "description": "Name of Git branch that updates rule. Used if type is \"deployment\"", - "example": "main" + "example": "main", + "default": "" }, "status": { "description": "Domain verification status. Possible values are \"unverified\", \"verifying\", \"verified\"", @@ -155781,12 +158881,14 @@ ], "title": "verified" } - ] + ], + "default": "unverified" }, "logs": { "type": "string", "description": "Logs from rule verification or certificate generation. Certificate generation logs are prioritized if both are available.", - "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.", + "default": "" }, "renewAt": { "type": "string", @@ -155796,12 +158898,14 @@ "projectId": { "type": "string", "description": "Project ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "region": { "type": "string", "description": "Region ID.", - "example": "fra" + "example": "fra", + "default": "" }, "tags": { "type": "object", @@ -155860,7 +158964,8 @@ "deploymentId": { "type": "string", "description": "Deployment ID of function", - "example": "fid8jx6ws45jana098ab7" + "example": "fid8jx6ws45jana098ab7", + "default": "" }, "variables": { "type": "object", @@ -155869,7 +158974,8 @@ "example": { "API_KEY": "your-api-key", "DEBUG": "true" - } + }, + "default": {} }, "headers": { "type": "object", @@ -155878,7 +158984,8 @@ "example": { "X-Appwrite-Key": "your-api-key", "DEBUG": "true" - } + }, + "default": {} }, "scopes": { "type": "array", @@ -155890,6 +158997,7 @@ "users.read", "users.write" ], + "default": [], "nullable": true }, "execute": { @@ -155902,55 +159010,65 @@ "any", "guest" ], + "default": [], "nullable": true }, "timeout": { "type": "integer", "description": "Function timeout in seconds.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "source": { "type": "string", "description": "Build source path", - "example": "" + "example": "", + "default": "" }, "entrypoint": { "type": "string", "description": "Build entrypoint file", - "example": "" + "example": "", + "default": "" }, "version": { "type": "string", "description": "Function version.", - "example": "v4" + "example": "v4", + "default": "v2" }, "cpus": { "type": "number", "description": "Function CPU count.", "format": "double", - "example": 0.5 + "example": 0.5, + "default": 0.5 }, "memory": { "type": "integer", "description": "Function memory limit in MB.", "format": "int32", - "example": 512 + "example": 512, + "default": 512 }, "logging": { "type": "boolean", "description": "Function logging.", - "example": true + "example": true, + "default": true }, "image": { "type": "string", "description": "Runtime image name.", - "example": "" + "example": "", + "default": "" }, "command": { "type": "string", "description": "Function runtime command.", - "example": "nohup helpers\/start.sh \"node index.js\"" + "example": "nohup helpers\/start.sh \"node index.js\"", + "default": "" }, "tags": { "type": "object", @@ -156000,77 +159118,90 @@ "slug": { "type": "string", "description": "Specification slug. Use this value when creating a dedicated database.", - "example": "s-2vcpu-2gb" + "example": "s-2vcpu-2gb", + "default": "" }, "name": { "type": "string", "description": "Human readable specification name.", - "example": "Standard" + "example": "Standard", + "default": "" }, "price": { "type": "number", "description": "Monthly price of the specification in USD.", "format": "double", - "example": 20 + "example": 20, + "default": 0 }, "storageOverageRate": { "type": "number", "description": "Price per GB of storage above the included amount, per month, in USD.", "format": "double", - "example": 0.125 + "example": 0.125, + "default": 0 }, "bandwidthOverageRate": { "type": "number", "description": "Price per GB of bandwidth above the included amount, per month, in USD.", "format": "double", - "example": 0.08 + "example": 0.08, + "default": 0 }, "replicaRate": { "type": "number", "description": "High availability replica price as a fraction of the specification price.", "format": "double", - "example": 1 + "example": 1, + "default": 0 }, "pitrRate": { "type": "number", "description": "Point-in-time recovery price as a fraction of the specification price.", "format": "double", - "example": 0.2 + "example": 0.2, + "default": 0 }, "cpu": { "type": "integer", "description": "Allocated CPU in millicores.", "format": "int32", - "example": 2000 + "example": 2000, + "default": 0 }, "memory": { "type": "integer", "description": "Allocated memory in MB.", "format": "int32", - "example": 2048 + "example": 2048, + "default": 0 }, "maxConnections": { "type": "integer", "description": "Maximum number of concurrent connections.", "format": "int32", - "example": 200 + "example": 200, + "default": 0 }, "includedStorage": { "type": "integer", "description": "Included storage in GB before overage charges apply.", "format": "int32", - "example": 25 + "example": 25, + "default": 0 }, "includedBandwidth": { "type": "integer", "description": "Included bandwidth in GB before overage charges apply.", "format": "int32", - "example": 200 + "example": 200, + "default": 0 }, "enabled": { "type": "boolean", "description": "Whether the specification is available on the current plan.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -156120,7 +159251,8 @@ "type": "integer", "description": "Total number of specifications.", "format": "int32", - "example": 9 + "example": 9, + "default": 0 } }, "required": [ @@ -156140,13 +159272,15 @@ "type": "integer", "description": "Current number of active connections.", "format": "int32", - "example": 12 + "example": 12, + "default": 0 }, "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.", "format": "int32", - "example": 100 + "example": 100, + "default": 100 } }, "required": [ @@ -156166,17 +159300,20 @@ "type": "integer", "description": "Member index within the database. Read `role` for which member accepts writes: a failover moves the primary without renumbering the indexes.", "format": "int32", - "example": 0 + "example": 0, + "default": 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).", - "example": "primary" + "example": "primary", + "default": "unknown" }, "healthy": { "type": "boolean", "description": "Whether the replica is healthy.", - "example": true + "example": true, + "default": false }, "replicating": { "type": "boolean", @@ -156212,22 +159349,26 @@ "path": { "type": "string", "description": "Mount path of the volume.", - "example": "\/var\/lib\/postgresql\/data" + "example": "\/var\/lib\/postgresql\/data", + "default": "" }, "usedPercent": { "type": "string", "description": "Percentage of storage used.", - "example": "45%" + "example": "45%", + "default": "0%" }, "available": { "type": "string", "description": "Available storage space.", - "example": "55GB" + "example": "55GB", + "default": "0GB" }, "mounted": { "type": "boolean", "description": "Whether the volume is mounted.", - "example": true + "example": true, + "default": false } }, "required": [ @@ -156485,7 +159626,8 @@ "type": "integer", "description": "Aggregated stats for total file transformations.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "screenshotsGenerated": { "type": "array", @@ -156499,97 +159641,113 @@ "type": "integer", "description": "Aggregated stats for total file transformations.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "usersTotal": { "type": "integer", "description": "Aggregated stats for total users.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "executionsTotal": { "type": "integer", "description": "Aggregated stats for total executions.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "executionsMBSecondsTotal": { "type": "integer", "description": "Aggregated stats for function executions in mb seconds.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "buildsMBSecondsTotal": { "type": "integer", "description": "Aggregated stats for function builds in mb seconds.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "filesStorageTotal": { "type": "integer", "description": "Aggregated stats for total file storage.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "buildsStorageTotal": { "type": "integer", "description": "Aggregated stats for total builds storage.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "deploymentsStorageTotal": { "type": "integer", "description": "Aggregated stats for total deployments storage.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "databasesStorageTotal": { "type": "integer", "description": "Aggregated stats for total databases storage.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "databasesReadsTotal": { "type": "integer", "description": "Aggregated stats for total databases reads.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "databasesWritesTotal": { "type": "integer", "description": "Aggregated stats for total databases writes.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "backupsStorageTotal": { "type": "integer", "description": "Aggregated stats for total backups storage.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "avatarsStorageTotal": { "type": "integer", "description": "Aggregated stats for total custom user photos storage.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "storageTotal": { "type": "integer", "description": "Aggregated stats for total storage.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "authPhoneTotal": { "type": "integer", "description": "Aggregated stats for total auth phone.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "authPhoneEstimate": { "type": "integer", "description": "Aggregated stats for total auth phone estimation.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "projects": { "type": "array", @@ -156611,7 +159769,8 @@ "type": "integer", "description": "Aggregated stats for total realtime connections.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "realtimeMessages": { "type": "array", @@ -156625,7 +159784,8 @@ "type": "integer", "description": "Aggregated stats for total realtime messages.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "realtimeBandwidth": { "type": "array", @@ -156639,7 +159799,8 @@ "type": "integer", "description": "Aggregated stats for total realtime bandwidth.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 } }, "required": [ @@ -156716,19 +159877,22 @@ "projectId": { "type": "string", "description": "projectId", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "bandwidth": { "type": "integer", "description": "Aggregated stats for number of requests.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "users": { "type": "integer", "description": "Aggregated stats for consumed bandwidth.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "executions": { "type": "integer", @@ -156740,25 +159904,29 @@ "type": "integer", "description": "Aggregated stats for database reads.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "databasesWrites": { "type": "integer", "description": "Aggregated stats for database writes.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "executionsMBSeconds": { "type": "integer", "description": "Aggregated stats for function executions in mb seconds.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "buildsMBSeconds": { "type": "integer", "description": "Aggregated stats for function builds in mb seconds.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "storage": { "type": "integer", @@ -156782,55 +159950,64 @@ "type": "integer", "description": "Aggregated stats for total databases reads.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "databasesWritesTotal": { "type": "integer", "description": "Aggregated stats for total databases writes.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "imageTransformations": { "type": "integer", "description": "Aggregated stats for file transformations.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "imageTransformationsTotal": { "type": "integer", "description": "Aggregated stats for total file transformations.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "screenshotsGenerated": { "type": "integer", "description": "Aggregated stats for file transformations.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "screenshotsGeneratedTotal": { "type": "integer", "description": "Aggregated stats for total file transformations.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "realtimeConnections": { "type": "integer", "description": "Aggregated stats for realtime connections.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "realtimeMessages": { "type": "integer", "description": "Aggregated stats for realtime messages.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "realtimeBandwidth": { "type": "integer", "description": "Aggregated stats for realtime bandwidth.", "format": "int32", - "example": 0 + "example": 0, + "default": 0 } }, "required": [ @@ -156885,45 +160062,53 @@ "name": { "type": "string", "description": "Invoice name", - "example": "" + "example": "", + "default": "" }, "value": { "type": "integer", "description": "Invoice value", "format": "int32", - "example": 0 + "example": 0, + "default": 0 }, "amount": { "type": "number", "description": "Invoice amount", "format": "double", - "example": 500 + "example": 500, + "default": 0 }, "rate": { "type": "number", "description": "Invoice rate", "format": "double", - "example": 12.5 + "example": 12.5, + "default": 0 }, "desc": { "type": "string", "description": "Invoice description", - "example": "Your monthly recurring Pro plan." + "example": "Your monthly recurring Pro plan.", + "default": "" }, "resourceId": { "type": "string", "description": "Resource ID", - "example": "" + "example": "", + "default": "" }, "type": { "type": "string", "description": "Dedicated database engine type for per-database line items (e.g. postgresql). Empty for other resources.", - "example": "postgresql" + "example": "postgresql", + "default": "" }, "specification": { "type": "string", "description": "Dedicated database specification slug for per-database line items (e.g. s-2vcpu-2gb). Empty for other resources.", - "example": "s-2vcpu-2gb" + "example": "s-2vcpu-2gb", + "default": "" } }, "required": [ @@ -156954,47 +160139,56 @@ "$id": { "type": "string", "description": "App ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "App creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "App update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Application name.", - "example": "My Application" + "example": "My Application", + "default": "" }, "description": { "type": "string", "description": "Application description shown to users during OAuth2 consent.", - "example": "Connect your workspace to My Application." + "example": "Connect your workspace to My Application.", + "default": "" }, "clientUri": { "type": "string", "description": "Application homepage URL shown to users during OAuth2 consent.", - "example": "https:\/\/example.com" + "example": "https:\/\/example.com", + "default": "" }, "logoUri": { "type": "string", "description": "Application logo URL shown to users during OAuth2 consent.", - "example": "https:\/\/example.com\/logo.png" + "example": "https:\/\/example.com\/logo.png", + "default": "" }, "privacyPolicyUrl": { "type": "string", "description": "Application privacy policy URL shown to users during OAuth2 consent.", - "example": "https:\/\/example.com\/privacy" + "example": "https:\/\/example.com\/privacy", + "default": "" }, "termsUrl": { "type": "string", "description": "Application terms of service URL shown to users during OAuth2 consent.", - "example": "https:\/\/example.com\/terms" + "example": "https:\/\/example.com\/terms", + "default": "" }, "contacts": { "type": "array", @@ -157004,12 +160198,14 @@ }, "example": [ "support@example.com" - ] + ], + "default": [] }, "tagline": { "type": "string", "description": "Application tagline shown to users during OAuth2 consent.", - "example": "Automate your workspace." + "example": "Automate your workspace.", + "default": "" }, "tags": { "type": "array", @@ -157020,7 +160216,8 @@ "example": [ "productivity", "automation" - ] + ], + "default": [] }, "labels": { "type": "array", @@ -157030,7 +160227,8 @@ }, "example": [ "featured" - ] + ], + "default": [] }, "images": { "type": "array", @@ -157040,17 +160238,20 @@ }, "example": [ "https:\/\/example.com\/screenshot.png" - ] + ], + "default": [] }, "supportUrl": { "type": "string", "description": "Application support URL shown to users during OAuth2 consent.", - "example": "https:\/\/example.com\/support" + "example": "https:\/\/example.com\/support", + "default": "" }, "dataDeletionUrl": { "type": "string", "description": "Application data deletion URL shown to users during OAuth2 consent.", - "example": "https:\/\/example.com\/data-deletion" + "example": "https:\/\/example.com\/data-deletion", + "default": "" }, "redirectUris": { "type": "array", @@ -157060,7 +160261,8 @@ }, "example": [ "https:\/\/example.com\/callback" - ] + ], + "default": [] }, "postLogoutRedirectUris": { "type": "array", @@ -157070,32 +160272,38 @@ }, "example": [ "https:\/\/example.com\/logged-out" - ] + ], + "default": [] }, "enabled": { "type": "boolean", "description": "Whether the app is enabled or not.", - "example": true + "example": true, + "default": 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.", - "example": "confidential" + "example": "confidential", + "default": "confidential" }, "deviceFlow": { "type": "boolean", "description": "Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).", - "example": false + "example": false, + "default": false }, "teamId": { "type": "string", "description": "ID of team that owns the application, if owned by team. Otherwise, user ID will be used.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "userId": { "type": "string", "description": "ID of user who owns the application, if owned by user. Otherwise, team ID will be used.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "installationScopes": { "type": "array", @@ -157105,12 +160313,14 @@ }, "example": [ "organization:organization.read" - ] + ], + "default": [] }, "installationRedirectUrl": { "type": "string", "description": "URL users are redirected to after creating or updating an installation of this application. Empty for no redirect.", - "example": "https:\/\/example.com\/setup" + "example": "https:\/\/example.com\/setup", + "default": "" }, "secrets": { "type": "array", @@ -157200,42 +160410,50 @@ "$id": { "type": "string", "description": "Secret ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Secret creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Secret update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "appId": { "type": "string", "description": "Application ID this secret belongs to.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "secret": { "type": "string", "description": "Always empty. The application client secret is returned only once, in the response of the createSecret method.", - "example": "" + "example": "", + "default": "" }, "hint": { "type": "string", "description": "Last few characters of the client secret, used to help identify it.", - "example": "f5c6c7" + "example": "f5c6c7", + "default": "" }, "createdById": { "type": "string", "description": "ID of the user who created the secret.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "createdByName": { "type": "string", "description": "Name of the user who created the secret.", - "example": "Walter White" + "example": "Walter White", + "default": "" }, "lastAccessedAt": { "type": "string", @@ -157273,42 +160491,50 @@ "$id": { "type": "string", "description": "Secret ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Secret creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Secret update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "appId": { "type": "string", "description": "Application ID this secret belongs to.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "secret": { "type": "string", "description": "Application client secret. Returned only when the secret is created; subsequent reads always return an empty value.", - "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a", + "default": "" }, "hint": { "type": "string", "description": "Last few characters of the client secret, used to help identify it.", - "example": "f5c6c7" + "example": "f5c6c7", + "default": "" }, "createdById": { "type": "string", "description": "ID of the user who created the secret.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "createdByName": { "type": "string", "description": "Name of the user who created the secret.", - "example": "Walter White" + "example": "Walter White", + "default": "" }, "lastAccessedAt": { "type": "string", @@ -157346,27 +160572,32 @@ "value": { "type": "string", "description": "Scope value as requested by apps.", - "example": "organization:organization.read" + "example": "organization:organization.read", + "default": "" }, "description": { "type": "string", "description": "Human-readable description of what the scope grants.", - "example": "Access to read the organization" + "example": "Access to read the organization", + "default": "" }, "type": { "type": "string", "description": "What the scope grants access to. One of `account`, `project`, or `organization`. Only `project` and `organization` scopes are installable.", - "example": "organization" + "example": "organization", + "default": "" }, "category": { "type": "string", "description": "Scope category, used to group scopes on consent and installation screens.", - "example": "Organization" + "example": "Organization", + "default": "" }, "deprecated": { "type": "boolean", "description": "Whether the scope is deprecated. Deprecated scopes can still be requested but should not be offered for new grants.", - "example": false + "example": false, + "default": false } }, "required": [ @@ -157391,27 +160622,32 @@ "$id": { "type": "string", "description": "Installation ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Installation creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Installation update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "appId": { "type": "string", "description": "ID of the installed application.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "teamId": { "type": "string", "description": "ID of the team the application is installed on.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "scopes": { "type": "array", @@ -157421,7 +160657,8 @@ }, "example": [ "organization:organization.read" - ] + ], + "default": [] }, "authorizationDetails": { "type": "array", @@ -157436,17 +160673,20 @@ "*" ] } - ] + ], + "default": [] }, "createdById": { "type": "string", "description": "ID of the user who created the installation.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "createdByName": { "type": "string", "description": "Name of the user who created the installation.", - "example": "Walter White" + "example": "Walter White", + "default": "" }, "lastAccessedAt": { "type": "string", @@ -157495,42 +160735,50 @@ "$id": { "type": "string", "description": "App key ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "App key creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "App key update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "appId": { "type": "string", "description": "Application ID this app key belongs to.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "secret": { "type": "string", "description": "App key secret.", - "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a", + "default": "" }, "hint": { "type": "string", "description": "Last few characters of the app key secret, used to help identify it.", - "example": "f5c6c7" + "example": "f5c6c7", + "default": "" }, "createdById": { "type": "string", "description": "ID of the user who created the app key.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "createdByName": { "type": "string", "description": "Name of the user who created the app key.", - "example": "Walter White" + "example": "Walter White", + "default": "" }, "lastAccessedAt": { "type": "string", @@ -157568,12 +160816,14 @@ "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.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "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.", - "example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + "example": "https:\/\/example.com\/callback?code=abcde&state=fghij", + "default": "" } }, "required": [ @@ -157592,7 +160842,8 @@ "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`.", - "example": "https:\/\/example.com\/callback?code=abcde&state=fghij" + "example": "https:\/\/example.com\/callback?code=abcde&state=fghij", + "default": "" } }, "required": [ @@ -157609,7 +160860,8 @@ "redirectUrl": { "type": "string", "description": "URL the end user should be redirected to after the grant is rejected, carrying an `access_denied` error.", - "example": "https:\/\/example.com\/callback?error=access_denied&state=fghij" + "example": "https:\/\/example.com\/callback?error=access_denied&state=fghij", + "default": "" } }, "required": [ @@ -157626,27 +160878,32 @@ "$id": { "type": "string", "description": "Grant ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Grant creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Grant update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "ID of the user the grant belongs to.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "appId": { "type": "string", "description": "ID of the OAuth2 client (app) the grant was requested for.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "scopes": { "type": "array", @@ -157658,7 +160915,8 @@ "openid", "email", "profile" - ] + ], + "default": [] }, "resources": { "type": "array", @@ -157668,33 +160926,39 @@ }, "example": [ "https:\/\/api.example.com\/" - ] + ], + "default": [] }, "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.", - "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]", + "default": "[]" }, "prompt": { "type": "string", "description": "OIDC prompt directive the consent screen should honor. Space-separated list of: login, consent, select_account.", - "example": "login" + "example": "login", + "default": "" }, "redirectUri": { "type": "string", "description": "Redirect URI the user will be sent to after the flow completes.", - "example": "https:\/\/example.com\/callback" + "example": "https:\/\/example.com\/callback", + "default": "" }, "authTime": { "type": "integer", "description": "Unix timestamp of when the user last authenticated.", "format": "int32", - "example": 1592981250 + "example": 1592981250, + "default": 0 }, "expire": { "type": "string", "description": "Grant expiration time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -157739,34 +161003,40 @@ "device_code": { "type": "string", "description": "Device verification code used by the client to poll the token endpoint.", - "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a" + "example": "5f3c8d2a1b9e4f7a6c8b2d1e9f4a7b3c5d8e1f2a9b4c7d6e3f5a8b1c4d7e2f9a", + "default": "" }, "user_code": { "type": "string", "description": "Short code the end user enters on the verification page.", - "example": "ABCD-EFGH" + "example": "ABCD-EFGH", + "default": "" }, "verification_uri": { "type": "string", "description": "URL where the end user enters the user code.", - "example": "https:\/\/appwrite.io\/oauth2\/device" + "example": "https:\/\/appwrite.io\/oauth2\/device", + "default": "" }, "verification_uri_complete": { "type": "string", "description": "Verification URL with the user code prefilled as a query parameter.", - "example": "https:\/\/appwrite.io\/oauth2\/device?user_code=ABCD-EFGH" + "example": "https:\/\/appwrite.io\/oauth2\/device?user_code=ABCD-EFGH", + "default": "" }, "expires_in": { "type": "integer", "description": "Lifetime of the device code and user code in seconds.", "format": "int32", - "example": 900 + "example": 900, + "default": 0 }, "interval": { "type": "integer", "description": "Minimum polling interval for the token endpoint in seconds.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 } }, "required": [ @@ -157793,13 +161063,15 @@ "request_uri": { "type": "string", "description": "Authorization request handle to pass to the authorize endpoint.", - "example": "urn:appwrite:oauth2:request:5e5ea5c16897e" + "example": "urn:appwrite:oauth2:request:5e5ea5c16897e", + "default": "" }, "expires_in": { "type": "integer", "description": "Lifetime of the authorization request handle in seconds.", "format": "int32", - "example": 600 + "example": 600, + "default": 0 } }, "required": [ @@ -157818,28 +161090,33 @@ "access_token": { "type": "string", "description": "OAuth2 access token.", - "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..." + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...", + "default": "" }, "token_type": { "type": "string", "description": "OAuth2 token type.", - "example": "Bearer" + "example": "Bearer", + "default": "Bearer" }, "expires_in": { "type": "integer", "description": "Access token lifetime in seconds.", "format": "int32", - "example": 3600 + "example": 3600, + "default": 0 }, "refresh_token": { "type": "string", "description": "OAuth2 refresh token.", - "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...", + "default": "" }, "scope": { "type": "string", "description": "Space-separated scopes granted to the access token.", - "example": "openid email profile" + "example": "openid email profile", + "default": "" }, "authorization_details": { "type": "string", @@ -157878,7 +161155,8 @@ "active": { "type": "boolean", "description": "Whether the token is currently active. An inactive token carries no other claims (RFC 7662).", - "example": true + "example": true, + "default": false }, "token_use": { "type": "string", @@ -157998,32 +161276,38 @@ "$id": { "type": "string", "description": "Consent ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Consent creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Consent update date in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "userId": { "type": "string", "description": "ID of the user the consent belongs to.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "appId": { "type": "string", "description": "ID of the registered app the consent was given to. Empty for URL-form (CIMD) clients.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "cimdUrl": { "type": "string", "description": "Client ID metadata document URL of the client the consent was given to. Empty for registered apps.", - "example": "https:\/\/example.com\/.well-known\/client-metadata.json" + "example": "https:\/\/example.com\/.well-known\/client-metadata.json", + "default": "" }, "scopes": { "type": "array", @@ -158035,7 +161319,8 @@ "openid", "email", "profile" - ] + ], + "default": [] }, "resources": { "type": "array", @@ -158045,17 +161330,20 @@ }, "example": [ "https:\/\/api.example.com\/" - ] + ], + "default": [] }, "authorizationDetails": { "type": "string", "description": "Authorization details the user consented to, as a JSON string. Each entry has a `type` plus project-defined fields.", - "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]", + "default": "[]" }, "expire": { "type": "string", "description": "Consent expiration time in ISO 8601 format. Empty when the consent has no token-bound expiry yet.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -158096,37 +161384,44 @@ "$id": { "type": "string", "description": "Token family ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "$createdAt": { "type": "string", "description": "Token creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "Token update date in ISO 8601 format. Refreshing the token family updates this.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "consentId": { "type": "string", "description": "ID of the consent the token family was issued under.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "userId": { "type": "string", "description": "ID of the user the token family belongs to.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "appId": { "type": "string", "description": "ID of the registered app the token family was issued to. Empty for URL-form (CIMD) clients.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "cimdUrl": { "type": "string", "description": "Client ID metadata document URL of the client the token family was issued to. Empty for registered apps.", - "example": "https:\/\/example.com\/.well-known\/client-metadata.json" + "example": "https:\/\/example.com\/.well-known\/client-metadata.json", + "default": "" }, "scopes": { "type": "array", @@ -158138,7 +161433,8 @@ "openid", "email", "profile" - ] + ], + "default": [] }, "resources": { "type": "array", @@ -158148,17 +161444,20 @@ }, "example": [ "https:\/\/api.example.com\/" - ] + ], + "default": [] }, "authorizationDetails": { "type": "string", "description": "Authorization details granted on the token family, as a JSON string. Each entry has a `type` plus project-defined fields.", - "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]" + "example": "[{\"type\":\"calendar\",\"identifier\":\"primary\",\"actions\":[\"read_events\",\"create_event\"]}]", + "default": "[]" }, "expire": { "type": "string", "description": "Expiration time of the current access token of this family in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" } }, "required": [ @@ -158194,173 +161493,6 @@ "expire": "2020-10-15T06:38:00.000+00:00" } }, - "wafRule": { - "description": "WafRule", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Rule ID.", - "example": "wafRule1" - }, - "$createdAt": { - "type": "string", - "description": "WAF rule creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "WAF rule last update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" - }, - "name": { - "type": "string", - "description": "Human friendly rule name.", - "example": "Block anonymous POST traffic" - }, - "description": { - "type": "string", - "description": "Optional description for the rule.", - "example": "Blocks anonymous POST calls to \/v1\/graphql" - }, - "teamId": { - "type": "string", - "description": "Team ID.", - "example": "5e5ea5c16897e" - }, - "projectId": { - "type": "string", - "description": "Project ID.", - "example": "cloudConsole" - }, - "resourceType": { - "type": "string", - "description": "Resource type the rule is scoped to.", - "example": "functions" - }, - "resourceId": { - "type": "string", - "description": "Resource identifier. Empty for API-wide rules.", - "example": "functionId" - }, - "action": { - "description": "Action performed when the rule matches.", - "example": "deny", - "title": "WafRuleAction", - "type": "string", - "oneOf": [ - { - "type": "string", - "enum": [ - "bypass" - ], - "title": "bypass" - }, - { - "type": "string", - "enum": [ - "deny" - ], - "title": "deny" - }, - { - "type": "string", - "enum": [ - "challenge" - ], - "title": "challenge" - }, - { - "type": "string", - "enum": [ - "rateLimit" - ], - "title": "rateLimit" - }, - { - "type": "string", - "enum": [ - "redirect" - ], - "title": "redirect" - } - ] - }, - "priority": { - "type": "integer", - "description": "Evaluation priority. Lower values execute earlier.", - "format": "int32", - "example": 100 - }, - "enabled": { - "type": "boolean", - "description": "Whether the rule is active.", - "example": true - }, - "conditions": { - "type": "array", - "description": "List of conditions evaluated for this rule.", - "items": { - "type": "object" - }, - "example": [ - { - "method": "equal", - "attribute": "ip", - "values": [ - "127.0.0.1" - ] - } - ] - }, - "config": { - "type": "object", - "additionalProperties": true, - "description": "Action specific configuration.", - "example": {} - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "name", - "description", - "teamId", - "projectId", - "resourceType", - "resourceId", - "action", - "priority", - "enabled", - "conditions", - "config" - ], - "example": { - "$id": "wafRule1", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "Block anonymous POST traffic", - "description": "Blocks anonymous POST calls to \/v1\/graphql", - "teamId": "5e5ea5c16897e", - "projectId": "cloudConsole", - "resourceType": "functions", - "resourceId": "functionId", - "action": "deny", - "priority": 100, - "enabled": true, - "conditions": [ - { - "method": "equal", - "attribute": "ip", - "values": [ - "127.0.0.1" - ] - } - ], - "config": {} - } - }, "wafRuleBypass": { "description": "WafRuleBypass", "type": "object", @@ -158368,47 +161500,56 @@ "$id": { "type": "string", "description": "Rule ID.", - "example": "wafRule1" + "example": "wafRule1", + "default": "" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Human friendly rule name.", - "example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic", + "default": "" }, "description": { "type": "string", "description": "Optional description for the rule.", - "example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql", + "default": "" }, "teamId": { "type": "string", "description": "Team ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "projectId": { "type": "string", "description": "Project ID.", - "example": "cloudConsole" + "example": "cloudConsole", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "example": "functions" + "example": "functions", + "default": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "example": "functionId" + "example": "functionId", + "default": "" }, "action": { "description": "Action performed when the rule matches.", @@ -158457,12 +161598,14 @@ "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "example": true + "example": true, + "default": true }, "conditions": { "type": "array", @@ -158478,13 +161621,15 @@ "127.0.0.1" ] } - ] + ], + "default": [] }, "config": { "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "example": {} + "example": {}, + "default": {} } }, "required": [ @@ -158535,214 +161680,56 @@ "$id": { "type": "string", "description": "Rule ID.", - "example": "wafRule1" - }, - "$createdAt": { - "type": "string", - "description": "WAF rule creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" - }, - "$updatedAt": { - "type": "string", - "description": "WAF rule last update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" - }, - "name": { - "type": "string", - "description": "Human friendly rule name.", - "example": "Block anonymous POST traffic" - }, - "description": { - "type": "string", - "description": "Optional description for the rule.", - "example": "Blocks anonymous POST calls to \/v1\/graphql" - }, - "teamId": { - "type": "string", - "description": "Team ID.", - "example": "5e5ea5c16897e" - }, - "projectId": { - "type": "string", - "description": "Project ID.", - "example": "cloudConsole" - }, - "resourceType": { - "type": "string", - "description": "Resource type the rule is scoped to.", - "example": "functions" - }, - "resourceId": { - "type": "string", - "description": "Resource identifier. Empty for API-wide rules.", - "example": "functionId" - }, - "action": { - "description": "Action performed when the rule matches.", - "example": "deny", - "title": "WafRuleAction", - "type": "string", - "oneOf": [ - { - "type": "string", - "enum": [ - "bypass" - ], - "title": "bypass" - }, - { - "type": "string", - "enum": [ - "deny" - ], - "title": "deny" - }, - { - "type": "string", - "enum": [ - "challenge" - ], - "title": "challenge" - }, - { - "type": "string", - "enum": [ - "rateLimit" - ], - "title": "rateLimit" - }, - { - "type": "string", - "enum": [ - "redirect" - ], - "title": "redirect" - } - ] - }, - "priority": { - "type": "integer", - "description": "Evaluation priority. Lower values execute earlier.", - "format": "int32", - "example": 100 - }, - "enabled": { - "type": "boolean", - "description": "Whether the rule is active.", - "example": true - }, - "conditions": { - "type": "array", - "description": "List of conditions evaluated for this rule.", - "items": { - "type": "object" - }, - "example": [ - { - "method": "equal", - "attribute": "ip", - "values": [ - "127.0.0.1" - ] - } - ] - }, - "config": { - "type": "object", - "additionalProperties": true, - "description": "Action specific configuration.", - "example": {} - } - }, - "required": [ - "$id", - "$createdAt", - "$updatedAt", - "name", - "description", - "teamId", - "projectId", - "resourceType", - "resourceId", - "action", - "priority", - "enabled", - "conditions", - "config" - ], - "example": { - "$id": "wafRule1", - "$createdAt": "2020-10-15T06:38:00.000+00:00", - "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "name": "Block anonymous POST traffic", - "description": "Blocks anonymous POST calls to \/v1\/graphql", - "teamId": "5e5ea5c16897e", - "projectId": "cloudConsole", - "resourceType": "functions", - "resourceId": "functionId", - "action": "deny", - "priority": 100, - "enabled": true, - "conditions": [ - { - "method": "equal", - "attribute": "ip", - "values": [ - "127.0.0.1" - ] - } - ], - "config": {} - } - }, - "wafRuleChallenge": { - "description": "WafRuleChallenge", - "type": "object", - "properties": { - "$id": { - "type": "string", - "description": "Rule ID.", - "example": "wafRule1" + "example": "wafRule1", + "default": "" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Human friendly rule name.", - "example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic", + "default": "" }, "description": { "type": "string", "description": "Optional description for the rule.", - "example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql", + "default": "" }, "teamId": { "type": "string", "description": "Team ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "projectId": { "type": "string", "description": "Project ID.", - "example": "cloudConsole" + "example": "cloudConsole", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "example": "functions" + "example": "functions", + "default": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "example": "functionId" + "example": "functionId", + "default": "" }, "action": { "description": "Action performed when the rule matches.", @@ -158791,12 +161778,14 @@ "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "example": true + "example": true, + "default": true }, "conditions": { "type": "array", @@ -158812,30 +161801,215 @@ "127.0.0.1" ] } + ], + "default": [] + }, + "config": { + "type": "object", + "additionalProperties": true, + "description": "Action specific configuration.", + "example": {}, + "default": {} + } + }, + "required": [ + "$id", + "$createdAt", + "$updatedAt", + "name", + "description", + "teamId", + "projectId", + "resourceType", + "resourceId", + "action", + "priority", + "enabled", + "conditions", + "config" + ], + "example": { + "$id": "wafRule1", + "$createdAt": "2020-10-15T06:38:00.000+00:00", + "$updatedAt": "2020-10-15T06:38:00.000+00:00", + "name": "Block anonymous POST traffic", + "description": "Blocks anonymous POST calls to \/v1\/graphql", + "teamId": "5e5ea5c16897e", + "projectId": "cloudConsole", + "resourceType": "functions", + "resourceId": "functionId", + "action": "deny", + "priority": 100, + "enabled": true, + "conditions": [ + { + "method": "equal", + "attribute": "ip", + "values": [ + "127.0.0.1" + ] + } + ], + "config": {} + } + }, + "wafRuleChallenge": { + "description": "WafRuleChallenge", + "type": "object", + "properties": { + "$id": { + "type": "string", + "description": "Rule ID.", + "example": "wafRule1", + "default": "" + }, + "$createdAt": { + "type": "string", + "description": "WAF rule creation time in ISO 8601 format.", + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" + }, + "$updatedAt": { + "type": "string", + "description": "WAF rule last update time in ISO 8601 format.", + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" + }, + "name": { + "type": "string", + "description": "Human friendly rule name.", + "example": "Block anonymous POST traffic", + "default": "" + }, + "description": { + "type": "string", + "description": "Optional description for the rule.", + "example": "Blocks anonymous POST calls to \/v1\/graphql", + "default": "" + }, + "teamId": { + "type": "string", + "description": "Team ID.", + "example": "5e5ea5c16897e", + "default": "" + }, + "projectId": { + "type": "string", + "description": "Project ID.", + "example": "cloudConsole", + "default": "" + }, + "resourceType": { + "type": "string", + "description": "Resource type the rule is scoped to.", + "example": "functions", + "default": "api" + }, + "resourceId": { + "type": "string", + "description": "Resource identifier. Empty for API-wide rules.", + "example": "functionId", + "default": "" + }, + "action": { + "description": "Action performed when the rule matches.", + "example": "deny", + "title": "WafRuleAction", + "type": "string", + "oneOf": [ + { + "type": "string", + "enum": [ + "bypass" + ], + "title": "bypass" + }, + { + "type": "string", + "enum": [ + "deny" + ], + "title": "deny" + }, + { + "type": "string", + "enum": [ + "challenge" + ], + "title": "challenge" + }, + { + "type": "string", + "enum": [ + "rateLimit" + ], + "title": "rateLimit" + }, + { + "type": "string", + "enum": [ + "redirect" + ], + "title": "redirect" + } ] }, + "priority": { + "type": "integer", + "description": "Evaluation priority. Lower values execute earlier.", + "format": "int32", + "example": 100, + "default": 0 + }, + "enabled": { + "type": "boolean", + "description": "Whether the rule is active.", + "example": true, + "default": true + }, + "conditions": { + "type": "array", + "description": "List of conditions evaluated for this rule.", + "items": { + "type": "object" + }, + "example": [ + { + "method": "equal", + "attribute": "ip", + "values": [ + "127.0.0.1" + ] + } + ], + "default": [] + }, "config": { "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "example": {} + "example": {}, + "default": {} }, "challengeType": { "type": "string", "description": "Challenge type enforced when the rule matches.", - "example": "compute" + "example": "compute", + "default": "compute" }, "difficulty": { "type": "integer", "description": "Challenge difficulty from 1 (easiest) to 5 (hardest) enforced when the rule matches.", "format": "int32", - "example": 3 + "example": 3, + "default": 3 }, "ttl": { "type": "integer", "description": "Seconds a visitor stays cleared after passing the challenge before being challenged again.", "format": "int32", - "example": 1800 + "example": 1800, + "default": 1800 } }, "required": [ @@ -158892,47 +162066,56 @@ "$id": { "type": "string", "description": "Rule ID.", - "example": "wafRule1" + "example": "wafRule1", + "default": "" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Human friendly rule name.", - "example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic", + "default": "" }, "description": { "type": "string", "description": "Optional description for the rule.", - "example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql", + "default": "" }, "teamId": { "type": "string", "description": "Team ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "projectId": { "type": "string", "description": "Project ID.", - "example": "cloudConsole" + "example": "cloudConsole", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "example": "functions" + "example": "functions", + "default": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "example": "functionId" + "example": "functionId", + "default": "" }, "action": { "description": "Action performed when the rule matches.", @@ -158981,12 +162164,14 @@ "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "example": true + "example": true, + "default": true }, "conditions": { "type": "array", @@ -159002,41 +162187,48 @@ "127.0.0.1" ] } - ] + ], + "default": [] }, "config": { "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "example": {} + "example": {}, + "default": {} }, "limit": { "type": "integer", "description": "Maximum number of matching requests allowed for the given interval.", "format": "int32", - "example": 1000 + "example": 1000, + "default": 100 }, "interval": { "type": "integer", "description": "Interval in seconds for the rate limit window.", "format": "int32", - "example": 60 + "example": 60, + "default": 3600 }, "key": { "type": "string", "description": "Rate limit key: `ip` limits per client IP, `userId` limits per authenticated user.", - "example": "userId" + "example": "userId", + "default": "ip" }, "strategy": { "type": "string", "description": "Rate limit strategy: `fixedWindow`, `slidingWindow`, or `tokenBucket`.", - "example": "slidingWindow" + "example": "slidingWindow", + "default": "fixedWindow" }, "maxBucketSize": { "type": "integer", "description": "Maximum burst capacity in tokens, applied by the `tokenBucket` strategy. The sustained refill rate is `limit \/ interval`. Defaults to `limit`.", "format": "int32", - "example": 200 + "example": 200, + "default": 0 } }, "required": [ @@ -159097,47 +162289,56 @@ "$id": { "type": "string", "description": "Rule ID.", - "example": "wafRule1" + "example": "wafRule1", + "default": "" }, "$createdAt": { "type": "string", "description": "WAF rule creation time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "$updatedAt": { "type": "string", "description": "WAF rule last update time in ISO 8601 format.", - "example": "2020-10-15T06:38:00.000+00:00" + "example": "2020-10-15T06:38:00.000+00:00", + "default": "" }, "name": { "type": "string", "description": "Human friendly rule name.", - "example": "Block anonymous POST traffic" + "example": "Block anonymous POST traffic", + "default": "" }, "description": { "type": "string", "description": "Optional description for the rule.", - "example": "Blocks anonymous POST calls to \/v1\/graphql" + "example": "Blocks anonymous POST calls to \/v1\/graphql", + "default": "" }, "teamId": { "type": "string", "description": "Team ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "projectId": { "type": "string", "description": "Project ID.", - "example": "cloudConsole" + "example": "cloudConsole", + "default": "" }, "resourceType": { "type": "string", "description": "Resource type the rule is scoped to.", - "example": "functions" + "example": "functions", + "default": "api" }, "resourceId": { "type": "string", "description": "Resource identifier. Empty for API-wide rules.", - "example": "functionId" + "example": "functionId", + "default": "" }, "action": { "description": "Action performed when the rule matches.", @@ -159186,12 +162387,14 @@ "type": "integer", "description": "Evaluation priority. Lower values execute earlier.", "format": "int32", - "example": 100 + "example": 100, + "default": 0 }, "enabled": { "type": "boolean", "description": "Whether the rule is active.", - "example": true + "example": true, + "default": true }, "conditions": { "type": "array", @@ -159207,24 +162410,28 @@ "127.0.0.1" ] } - ] + ], + "default": [] }, "config": { "type": "object", "additionalProperties": true, "description": "Action specific configuration.", - "example": {} + "example": {}, + "default": {} }, "location": { "type": "string", "description": "Target location for the redirect.", - "example": "\/maintenance" + "example": "\/maintenance", + "default": "\/" }, "statusCode": { "type": "integer", "description": "HTTP status code used for the redirect.", "format": "int32", - "example": 301 + "example": 301, + "default": 302 } }, "required": [ @@ -159280,7 +162487,8 @@ "type": "integer", "description": "Total number of rules that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "rules": { "type": "array", @@ -159308,13 +162516,40 @@ "type": "integer", "description": "Total number of rules that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "rules": { "type": "array", "description": "List of rules.", "items": { - "$ref": "#\/components\/schemas\/wafRule" + "anyOf": [ + { + "$ref": "#\/components\/schemas\/wafRuleBypass" + }, + { + "$ref": "#\/components\/schemas\/wafRuleDeny" + }, + { + "$ref": "#\/components\/schemas\/wafRuleChallenge" + }, + { + "$ref": "#\/components\/schemas\/wafRuleRateLimit" + }, + { + "$ref": "#\/components\/schemas\/wafRuleRedirect" + } + ], + "discriminator": { + "propertyName": "action", + "mapping": { + "bypass": "#\/components\/schemas\/wafRuleBypass", + "deny": "#\/components\/schemas\/wafRuleDeny", + "challenge": "#\/components\/schemas\/wafRuleChallenge", + "rateLimit": "#\/components\/schemas\/wafRuleRateLimit", + "redirect": "#\/components\/schemas\/wafRuleRedirect" + } + } }, "example": [] } @@ -159335,17 +162570,20 @@ "$id": { "type": "string", "description": "Project ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" }, "region": { "type": "string", "description": "Region ID the project is deployed in.", - "example": "fra" + "example": "fra", + "default": "" }, "endpoint": { "type": "string", "description": "API endpoint of the region the project is deployed in. Empty when the region has no public hostname configured.", - "example": "https:\/\/fra.cloud.appwrite.io\/v1" + "example": "https:\/\/fra.cloud.appwrite.io\/v1", + "default": "" } }, "required": [ @@ -159366,7 +162604,8 @@ "$id": { "type": "string", "description": "Organization ID.", - "example": "5e5ea5c16897e" + "example": "5e5ea5c16897e", + "default": "" } }, "required": [ @@ -159384,7 +162623,8 @@ "type": "integer", "description": "Total number of projects that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "projects": { "type": "array", @@ -159412,7 +162652,8 @@ "type": "integer", "description": "Total number of organizations that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "organizations": { "type": "array", @@ -159440,7 +162681,8 @@ "type": "integer", "description": "Total number of consents that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "consents": { "type": "array", @@ -159468,7 +162710,8 @@ "type": "integer", "description": "Total number of tokens that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "tokens": { "type": "array", @@ -159496,7 +162739,8 @@ "type": "integer", "description": "Total number of events that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "events": { "type": "array", @@ -159524,7 +162768,8 @@ "type": "integer", "description": "Total number of addons that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "addons": { "type": "array", @@ -159552,7 +162797,8 @@ "type": "integer", "description": "Total number of properties that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "properties": { "type": "array", @@ -159580,7 +162826,8 @@ "type": "integer", "description": "Total number of aggregations that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "aggregations": { "type": "array", @@ -159608,7 +162855,8 @@ "type": "integer", "description": "Total number of archives that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "archives": { "type": "array", @@ -159636,7 +162884,8 @@ "type": "integer", "description": "Total number of policies that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "policies": { "type": "array", @@ -159664,7 +162913,8 @@ "type": "integer", "description": "Total number of restorations that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "restorations": { "type": "array", @@ -159692,7 +162942,8 @@ "type": "integer", "description": "Total number of billingAddresses that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "billingAddresses": { "type": "array", @@ -159720,7 +162971,8 @@ "type": "integer", "description": "Total number of invoices that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "invoices": { "type": "array", @@ -159748,7 +163000,8 @@ "type": "integer", "description": "Total number of plans that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "plans": { "type": "array", @@ -159776,7 +163029,8 @@ "type": "integer", "description": "Total number of blocks that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "blocks": { "type": "array", @@ -159796,6 +163050,35 @@ "blocks": "" } }, + "threatList": { + "description": "Threats list", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "Total number of threats that matched your query.", + "format": "int32", + "example": 5, + "default": 0 + }, + "threats": { + "type": "array", + "description": "List of threats.", + "items": { + "$ref": "#\/components\/schemas\/threat" + }, + "example": [] + } + }, + "required": [ + "total", + "threats" + ], + "example": { + "total": 5, + "threats": "" + } + }, "databaseMigrationList": { "description": "Database Migrations List", "type": "object", @@ -159804,7 +163087,8 @@ "type": "integer", "description": "Total number of migrations that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "migrations": { "type": "array", @@ -159832,7 +163116,8 @@ "type": "integer", "description": "Total number of databases that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "databases": { "type": "array", @@ -159860,7 +163145,8 @@ "type": "integer", "description": "Total number of dnsRecords that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "dnsRecords": { "type": "array", @@ -159888,7 +163174,8 @@ "type": "integer", "description": "Total number of suggestions that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "suggestions": { "type": "array", @@ -159916,7 +163203,8 @@ "type": "integer", "description": "Total number of prices that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "prices": { "type": "array", @@ -159944,7 +163232,8 @@ "type": "integer", "description": "Total number of domains that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "domains": { "type": "array", @@ -159972,7 +163261,8 @@ "type": "integer", "description": "Total number of teams that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "teams": { "type": "array", @@ -160000,7 +163290,8 @@ "type": "integer", "description": "Total number of paymentMethods that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "paymentMethods": { "type": "array", @@ -160028,7 +163319,8 @@ "type": "integer", "description": "Total number of extensions that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "extensions": { "type": "array", @@ -160056,7 +163348,8 @@ "type": "integer", "description": "Total number of regions that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "regions": { "type": "array", @@ -160084,7 +163377,8 @@ "type": "integer", "description": "Total number of apps that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "apps": { "type": "array", @@ -160112,7 +163406,8 @@ "type": "integer", "description": "Total number of secrets that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "secrets": { "type": "array", @@ -160140,7 +163435,8 @@ "type": "integer", "description": "Total number of scopes that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "scopes": { "type": "array", @@ -160168,7 +163464,8 @@ "type": "integer", "description": "Total number of installations that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "installations": { "type": "array", @@ -160196,7 +163493,8 @@ "type": "integer", "description": "Total number of keys that matched your query.", "format": "int32", - "example": 5 + "example": 5, + "default": 0 }, "keys": { "type": "array", From eac5695ade09d3e68a2309211abe7bb8da1f8352 Mon Sep 17 00:00:00 2001 From: Chirag Aggarwal Date: Mon, 12 Oct 2026 19:00:35 +0100 Subject: [PATCH 2/2] fix: keep the latest reference to methods the released SDKs ship Server, client and console SDKs released with passkeys are patched onto their last stable tags, so the latest spec documented methods and params none of them expose yet: email and recovery OTP, ID token sessions, avatar photos, the Appwrite messaging provider, Kakao, TikTok and Webflow OAuth2, the pwned and rotation password policies, Android signing fingerprints and custom membership IDs. --- specs/latest/open-api3-latest.json | 140 +++-------------------------- 1 file changed, 13 insertions(+), 127 deletions(-) diff --git a/specs/latest/open-api3-latest.json b/specs/latest/open-api3-latest.json index 87c552cd0..7c7d31883 100644 --- a/specs/latest/open-api3-latest.json +++ b/specs/latest/open-api3-latest.json @@ -4813,8 +4813,7 @@ "scope": "sessions.write", "platforms": [ "console", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -4894,8 +4893,7 @@ "scope": "sessions.write", "platforms": [ "console", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -5262,8 +5260,7 @@ "scope": "sessions.write", "platforms": [ "console", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -7787,8 +7784,7 @@ "scope": "account", "platforms": [ "console", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -7859,8 +7855,7 @@ "scope": "public", "platforms": [ "console", - "client", - "server" + "client" ], "packaging": false, "public": true, @@ -14749,9 +14744,7 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "avatars.write", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, @@ -14816,9 +14809,7 @@ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "avatars.write", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, @@ -51301,8 +51292,7 @@ "rate-key": "url:{url},ip:{ip}", "scope": "providers.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -51398,8 +51388,7 @@ "rate-key": "url:{url},ip:{ip}", "scope": "providers.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -83791,8 +83780,7 @@ "rate-key": "url:{url},ip:{ip}", "scope": "project.oauth2.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -85326,8 +85314,7 @@ "rate-key": "url:{url},ip:{ip}", "scope": "project.oauth2.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -85650,8 +85637,7 @@ "rate-key": "url:{url},ip:{ip}", "scope": "project.oauth2.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -86963,14 +86949,6 @@ "description": "Android application ID. Max length: 256 chars.", "type": "string", "example": "" - }, - "fingerprints": { - "description": "SHA-256 fingerprints of the certificates your app is signed with, such as \"14:6D:E9:...:2B:6A\". Passkeys created in the app are accepted when its signature matches one. Find them under App signing in Play Console, or with `.\/gradlew signingReport`.", - "type": "array", - "default": [], - "items": { - "type": "string" - } } }, "required": [ @@ -87061,14 +87039,6 @@ "description": "Android application ID. Max length: 256 chars.", "type": "string", "example": "" - }, - "fingerprints": { - "description": "SHA-256 fingerprints of the certificates your app is signed with, such as \"14:6D:E9:...:2B:6A\". Passkeys created in the app are accepted when its signature matches one. Find them under App signing in Play Console, or with `.\/gradlew signingReport`. Omit to keep the current list, or pass an empty array to clear it.", - "type": "array", - "items": { - "type": "string" - }, - "nullable": true } }, "required": [ @@ -88803,8 +88773,7 @@ "project.policies.write" ], "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, @@ -88852,83 +88821,6 @@ } } }, - "\/project\/policies\/password-rotation": { - "patch": { - "summary": "Update password rotation policy", - "operationId": "projectUpdatePasswordRotationPolicy", - "tags": [ - "project" - ], - "description": "Require a password reset when an email\/password sign-in uses a password older than the configured maximum age. Options left out keep their current value.", - "responses": { - "200": { - "description": "Project", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/project" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "group": "policies", - "demo": "project\/update-password-rotation-policy.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "policies.write", - "project.policies.write" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "console": { - "Project": [] - }, - "server": { - "Project": [], - "Key": [] - } - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "description": "Enable password rotation. Disabled by default.", - "type": "boolean", - "example": false - }, - "maxAge": { - "description": "Maximum password age in seconds. Minimum allowed value is 86400 seconds (1 day), and maximum is 10 years, which is 315360000 seconds. Defaults to 1 year, which is 31536000 seconds.", - "type": "integer", - "example": 86400, - "format": "int32" - } - } - } - } - } - } - } - }, "\/project\/policies\/password-strength": { "patch": { "summary": "Update password strength policy", @@ -113824,12 +113716,6 @@ "schema": { "type": "object", "properties": { - "membershipId": { - "description": "Membership 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.", - "type": "string", - "default": "", - "example": "" - }, "email": { "description": "Email of the new team member.", "type": "string",